Skip to content

docs: add conceptual overview and quick start to root README - #30

Open
Digitalenergyllc wants to merge 1 commit into
solana-foundation:mainfrom
Digitalenergyllc:fix/issue-18-root-readme
Open

docs: add conceptual overview and quick start to root README#30
Digitalenergyllc wants to merge 1 commit into
solana-foundation:mainfrom
Digitalenergyllc:fix/issue-18-root-readme

Conversation

@Digitalenergyllc

@Digitalenergyllc Digitalenergyllc commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

Closes #18

Summary

The root README only listed project directories with no explanation of what the governance system does, how the pieces fit together, or how to get started.

Changes

  • Added one-paragraph overview explaining the two governance tracks (SVM + NCN)
  • Added quick-start table linking to key docs by use case
  • Added contributing section pointing to open issues
  • Retained existing project structure section

Note

This PR and #36 both touch the end of README.md — whichever merges second will need a trivial rebase, which I'll push same-day.

Closes solana-foundation#18

The root README only listed project directories with no context about
what the governance system does, how the components relate, or where
to get started. Added overview, quick-start table, and contributing note.
@vercel

vercel Bot commented Apr 6, 2026

Copy link
Copy Markdown

@Digitalenergyllc is attempting to deploy a commit to the Solana Foundation Team on Vercel.

A member of the Team first needs to authorize it.

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.

docs: root README needs conceptual overview and getting-started guidance

1 participant