Restructured the developer documentation into the Diátaxis framework #2329
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
samtygier-stfc
requested changes
Sep 19, 2024
There was a problem hiding this comment.
The old content from docs/developer_guide/index.rst has been duplicated to docs/developer_guide/tutorials/started.rst and docs/developer_guide/how-to-guides/command.rst. Was the aim to split the Getting started and Command Line Arguments into separate pages?
Changes to docs/release_notes/next/featureE-2320-Enhance-System-Tests -for-Spectrum-Viewer and mantidimaging/gui/test/gui_system_spectrum_test.py have been include. Might need a rebase to remove them.
ashmeigh
force-pushed
the
2279_Developer_Documentation_on_System_Testing
branch
2 times, most recently
from
c956a2b
to
f3c4d27
Compare
ashmeigh
force-pushed
the
2279_Developer_Documentation_on_System_Testing
branch
from
f3c4d27
to
95030b2
Compare
samtygier-stfc
approved these changes
Oct 10, 2024
samtygier-stfc
deleted the
2279_Developer_Documentation_on_System_Testing
branch
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.
Issue
Closes #2328
Description
Restructured the developer documentation into the Diátaxis framework. The documentation is now categorized into Tutorials, How-To Guides, Explanations, and Reference to improve navigation and consistency, following the structure used in the Pandas developer docs. This change is aimed at making it easier for contributors to locate relevant information based on their level of experience and the specific tasks they are working on.
Testing
Verified the structure by navigating through the developer documentation in the new format, ensuring that each section properly falls under the intended category (Tutorials, How-To Guides, Explanations, Reference).