Skip to content

docs(readme): rewrite README for public audience#153

Merged
marc0olo merged 1 commit into
mainfrom
infra/public-readme
Apr 28, 2026
Merged

docs(readme): rewrite README for public audience#153
marc0olo merged 1 commit into
mainfrom
infra/public-readme

Conversation

@marc0olo
Copy link
Copy Markdown
Member

Summary

  • Replaces the internal working-doc README with a polished public-facing README
  • Adds context and motivation: why this repo exists, the transition from dfinity/portal
  • Covers current state, content areas, quick start, contributing rules, agent workflow, and agent-friendly documentation endpoints
  • Removes internal-only details (Beads references, work-in-progress banner, internal workflow diagrams)
  • Keeps the agent-friendly documentation section (llms.txt, .md endpoints) and the related resources table

Sync recommendation

hand-written

Replaces the internal working-doc README with a polished public-facing
README: context and motivation behind the rewrite, current state, content
areas, quick start, contributing rules, agent workflow, and agent-friendly
documentation endpoints.
@marc0olo marc0olo merged commit 7dcbccb into main Apr 28, 2026
1 check passed
@marc0olo marc0olo deleted the infra/public-readme branch April 28, 2026 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant