Skip to content

Conversation

@mcmire
Copy link
Contributor

@mcmire mcmire commented Jan 8, 2026

Explanation

Most of the contributor docs are kept in one main file, but as time as gone on we have split out specific topics into their own files. Some files are not linked from the main file at all. Finally, one of the files in docs/ is intended for the core-backend repo, not the repo as a whole.

Ultimately, this is confusing for contributors.

This commit converts the main file to a table of contents, organized by category, and makes sure to link to every file in docs/. It also moves the core-backend-specific file to that package.

Note that the exact makeup of the documentation isn't perfect. We might need to rearrange some things a bit so that we have better divisions of content. There is also some duplicated content, particularly around changelogs. I'll work on that in a future PR.

View rendered version

References

Related to https://consensyssoftware.atlassian.net/browse/WPC-199.

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Revamps contributor documentation into a structured, discoverable layout.

  • Replaces docs/contributing.md with a new docs/README.md table-of-contents and adds sectioned guides under docs/getting-started/, docs/processes/, and docs/code-guidelines/
  • Updates links in README.md, PR template, scripts/create-package/README.md, and preview-build message to point to new doc paths
  • Fixes/clarifies headings and intra-repo links in controller/data-service guidelines
  • Adjusts .gitignore to include packages/core-backend/docs and keeps example/docs ignores
  • Removes obsolete docs/contributing.md

Written by Cursor Bugbot for commit 9d711b6. This will update automatically on new commits. Configure here.

@mcmire mcmire force-pushed the reorganize-docs branch 2 times, most recently from 3b3a74c to 0432905 Compare January 8, 2026 16:08
@mcmire mcmire marked this pull request as ready for review January 8, 2026 16:16
@mcmire mcmire requested a review from a team as a code owner January 8, 2026 16:16
@mcmire mcmire force-pushed the reorganize-docs branch 3 times, most recently from 701d482 to bd00e79 Compare January 8, 2026 16:23
@mcmire mcmire requested a review from a team as a code owner January 8, 2026 16:23
Most of the contributor docs are kept in one main file, but as time as
gone on we have split out specific topics into their own files. Some
files are not linked from the main file at all. Finally, one of the
files in `docs/` is intended for the `core-backend` repo, not the repo
as a whole.

Ultimately, this is confusing for contributors.

This commit converts the main file to a table of contents, organized by
category, and makes sure to link to every file in `docs/`. It also moves
the `core-backend`-specific file to that package.
mcmire and others added 2 commits January 9, 2026 08:00
Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
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.

3 participants