Skip to content

docs: rewrite README and contributing guide for public readers - #9

Draft
jm-rivera wants to merge 2 commits into
devfrom
docs/public-repo-docs
Draft

jm-rivera wants to merge 2 commits into
devfrom
docs/public-repo-docs

Conversation

@jm-rivera

Copy link
Copy Markdown
Contributor

Rewrites the README and contributing guide for a public reader and moves build and sync internals into docs/development.md.

README.md now says where the docs are published (https://developmentfinance.org/docs), how the content is organised, and how to propose a change to a page. CONTRIBUTING.md gains the code of conduct and security links, lists the checks (ruff, ty, pytest, the build and lychee), and adds a pull request section. Adding a repository to the source registry, running and publishing the build, the Google Docs sync, and the build-failure guide move from the README to docs/development.md near verbatim. There is no site generator nav, so the new page cannot affect the build, and lychee checks only the built corpus.

CONTRIBUTING.md links the organisation code of conduct, security policy and support guide by absolute URL. Those links resolve once DevelopmentFinanceObservatory/.github#1 merges.

Testing: pre-commit run --files (mdformat, codespell, hygiene hooks) passes on the three files, https://developmentfinance.org/docs returns 200, and every relative link resolves. Content under content/ and roadmap/ is untouched.

Keeps the rewritten README and carries dev's renamed skills repository reference into docs/development.md, where the branch moved that section.

This branch has not been deployed

No deployments
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