reorganize docs to include architectural decisions #1470
Closed
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
joelhawksley
requested review from
a team,
BlakeWilliams,
Spone,
dylanatsmith,
elia and
juanmanuelramallo
as code owners
Contributor
|
3 file(s) had their final line ending fixed:
|
Collaborator
|
What do you think about leaving the Changelog as a first-level item? It's probably the page I check the most frequently, and I'm not sure I would expect to find it under "About the project". |
Member
Author
|
I think I'm going to take a lighter touch for now. Closing. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What are you trying to accomplish?
Our ADRs are not easily discovered in the repo. I'm reorganizing the documentation into categories and adding a section for architectural decisions.
What approach did you choose and why?
I added a section to the docs site.
Anything you want to highlight for special attention from reviewers?
No