A New Project Description

blog · updated

Below is the updated README.md for the project.

Overview

PublicTxt is a stab at using plaintext based git repos as efficient stores of public, community, and semi-private and private content. And then hopefully, eventually also a bunch of tooling that works with these git repos to store, share, and organise content/knowledge/community. The idea is to combine the power of Git’s version control with strong graphs of connected public content to provide a way for systems to store and interoperate with content for public discourse, web browsing, social bookmarking, wikis and blogging. It aims to enhance how we manage, share, and interact with information in a transparent, collaborative online space.

The experiment is in early stages. Links to software repositories for tooling that works work these plaintext repositories to follow.

Key Features of the ecosystem

  • Plain text: Using Markdown for simple, flexible content creation and editing. Tags and more complex metadata is stored using an open plaintext protocol.
  • Immutable Public Records: Leveraging Git commits - possibly in combination with other forms of distributed ledgers - for transparent and reliable record-keeping.
  • Consensus and Reputation Mechanisms: Empowering community-driven content management and peer review.
  • Fluid Community Controls: Flexibility with public, semi-public, and private content settings.
  • MetaWeb Commons Functionality: A browser extension that integrates Git repositories that contain discussion and notes about web pages with the web browsing experience.
  • Social Bookmarking and Blogging: Interactive platforms for content creation and sharing.
  • Desktop and Mobile UI: Accessible interfaces for diverse devices, enhancing user interaction, content discovery and creation, and community engagement.
  • Web API: A central conduit for seamless data integration and communication.
  • ActivityPub: integration with the decentralized social networking protocol.

Public Text Template

Using this Repository to work or play with the format

  • This repo should also function as a template of the format. Although it also holds a wiki and other content about the entire PublicTxt idea. If
  • This repository should be able to be used with custom software, like the hoped for browser extension and other tooling.
  • Suggest changes via pull requests, issues, comments, or by forking the repository and creating your own version of the template.

Directory Structure

The directory structure for a Public Text repository is as follows:

  • blog: Contains blog posts
    • year (eg 2023)
      • month (eg 01)
        • day (eg 01)
          • date.md: (eg 20231217.md) Contains the blog post
          • title.md: other posts for the day
  • wiki: Contains wiki pages
  • notes: Contains notes
  • media: Contains media files
  • metaweb: Contains bookmarks, annotations and notes about web pages
    • sites: (eg www.example.com.md) folder containing all web pages with data for that site
    • bookmarks
    • notes
    • annotations
    • indexes: Contains indexes for web pages
    • tags: tag indexes for metaweb content
  • tags: Contains tag indexes for the entire repository
  • indexes: Contains indexes for the entire repository
  • community: Contains community content
    • discussion: Contains discussion threads
    • profiles: Contains user profiles
    • groups: Contains group profiles
    • settings: Contains settings files
    • indexes: Contains indexes for community content
    • tags: Contains tag indexes for community content
  • settings: Contains settings files

License

Contributing