Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve development doc structure #2672

Closed
wants to merge 2 commits into from

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Jan 8, 2025

  • Remove the roadmap, since this seems to be a historical document that is out of date. Alternatively we could keep this here and put a disclaimer that it's a historical document at the top?
  • Split the developer's guide into two pages, one for contributors, and one for maintainers. I think this makes the content more discoverable (for both sets of people), and also keeps the contributor's guide a bit simpler.

@jhamman
Copy link
Member

jhamman commented Jan 8, 2025

I'd like to keep the roadmap page. There is already a disclaimer explaining the status / historical significance of the page. Medium term, I'd like to update this document. The 3.0 release opens the door to some really cool stuff and this is the place where we can explain where the project intends to go.

@dstansby
Copy link
Contributor Author

dstansby commented Jan 8, 2025

👍 - I didn't spot the note initially (my bad), I've just moved it to the top of the page in the latest revision.

@dstansby dstansby added the needs release notes Automatically applied to PRs which haven't added release notes label Jan 9, 2025
@dstansby dstansby closed this Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs release notes Automatically applied to PRs which haven't added release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants