diff --git a/docs/design_doc_blueprint.md b/docs/design_doc_blueprint.md new file mode 100644 index 0000000000..00bd6ddb2a --- /dev/null +++ b/docs/design_doc_blueprint.md @@ -0,0 +1,44 @@ +# Title + +> A cool name for your Project + +Author: [Your-Name](mailto:your-name@reachable.com) + +> If there are multiple authors, just list them all + +## Summary + +A short summary of your project/re-design/component and what problems it +addresses in about 3-10 sentences. + +## State of the Feature as of `$VERSION` (optional) + +The state of the feature you want to improve and where it currently falls +short. If there's nothing to compare to, leave it out. + +## Goals and non-goals + +Direct goals of the project and features deemed not worth pursuing. + +## Overview + +A detailed overview of the project and the improvements it brings. + +### Detailed Design + +The place to describe all new interfaces and interactions and how it plays into +the existing code and behavior. This is the place for all nitty-gritty details +which interact with the system. + +## Alternatives considered (optional) + +Other alternatives to your suggested approach, and why they fall short. + +### Issues addressed (optional) + +A list of issues which are addressed by this design. + +## Future Possibilities + +The section for things which could be added to it or deemed out of scope during +the discussion. diff --git a/docs/design_docs.md b/docs/design_docs.md index 8caa02ed94..e1d1c0137e 100644 --- a/docs/design_docs.md +++ b/docs/design_docs.md @@ -20,3 +20,9 @@ already familiar with the codebase, to not stall the implementation. [Rust RFCs]: https://github.com/rust-lang/rfcs + +## Blueprint (Template) + +You can find the base template of a new Design Doc +[here](design_doc_blueprint.md). + diff --git a/mkdocs.yml b/mkdocs.yml index dfba94a1ed..9659e392e2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -129,6 +129,7 @@ nav: - 'Guidelines and "How to...?"': 'contributing.md' - 'Code of conduct': 'code-of-conduct.md' - 'Design Docs': 'design_docs.md' + - 'Design Doc Blueprint': 'design_doc_blueprint.md' - 'Design docs': - 'git-submodules': 'design/git-submodules.md'