Documentation restructure#330
Open
martyn-fewtrell wants to merge 4 commits into
Open
Conversation
Add documentation.instructions.md with detailed authoring guidance, including documentation modes, mapping, and a contributor checklist. Update CONTRIBUTING.md with a mapping table for document types. Revise README.md files to clarify the purpose and navigation of each documentation area.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Updated list markers in README.md to use consistent Markdown formatting. Changed '-' to '*' and vice versa in relevant sections to align with best practices. No content changes were made.
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
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.
PR Classification
Documentation restructure and content update.
PR Summary
This pull request restructures the documentation repository for improved clarity, navigation, and consistency, updating content and internal links to match a new organizational scheme.