Document repository structure and conventions #535
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The details of how this repository works -- the goal and roadmap document formats, metadata fields, preprocessor directives, crate layout, CI checks, etc. -- were previously undocumented, underdocumented, or spread across many places. In this commit, we collect and consolidate it into a single reference document. The document covers: - Repository structure and crate architecture. - Goal document format: metadata table (with which rows are parsed vs. merely conventional), required sections, team asks, support levels, and the pre-2026 format. - Roadmap document format and metadata. (Notes that the roadmap template is currently out of date with respect to metadata tables.) - All mdBook preprocessor directives and legacy synonyms. - Essential commands and CI workflow details (what each workflow runs and when it triggers). - Rust code conventions and contribution guidelines.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The details of how this repository works -- the goal and roadmap document formats, metadata fields, preprocessor directives, crate layout, CI checks, etc. -- were previously undocumented, underdocumented, or spread across many places. In this commit, we collect and consolidate it into a single reference document.
The document covers:
cc @nikomatsakis