Organise documentation #1939
Open
Organise documentation #1939
+179
−150
Conversation
This file contains 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
By providing a clear entry point and a linear developer setup story, we can make life easier for future developers. - There is now a README.md index document in the doc directory. - The "getting started" and "development environment" documents are combined into a single linear narrative. - All documentation files are linked from the documentation index, which is linked from the root README.md
|
The best way to understand the changes is to visit the branch in GitHub: https://github.com/DFE-Digital/buy-for-your-school/tree/organise-docs |
|
Test coverageLine: 87.37% |
serenaabbott11
approved these changes
Oct 23, 2024
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.
By providing a clear entry point and a linear developer setup story, we can make life easier for future developers.
Changes in this PR