[Draft] Developer Documentation Refactor #3034
Merged
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
* Moved developer specific markdown documents from /doc to /doc/dev. Searched repository and WIKI for references to these files (there were none to fix). * Moved 'Tools' section from CONTRIBUTING into new file /doc/dev/tools.md * Moved 'Guidelines for Repository Contributions' from CONTRIBUTING into new file /doc/dev/guidelines.md * Created new file /doc/dev/additional_info.md. Links include references to the WIKI. * Added a footer to each of the developer specific documents that link to 'Additional Developer Resources'. Now the developer documents are cross-referenced with each other. I have previously made a change to the WIKI home page referencing the developer start page as an entry point into this documentation. Their are other developer specific WIKI pages that could link to Additional Developer Resources. There change is outside the scope of this PR.
seangoodvibes
requested changes
Dec 9, 2024
added 3 commits
December 9, 2024 15:39
* **AMEND** moving menu_hierarchies.md back to /doc. **AMEND** Removing bug_fixes.md. * Moved developer specific markdown documents from /doc to /doc/dev. Searched repository and WIKI for references to these files (there were none to fix). * Moved 'Tools' section from CONTRIBUTING into new file /doc/dev/tools.md * Moved 'Guidelines for Repository Contributions' from CONTRIBUTING into new file /doc/dev/guidelines.md * Created new file /doc/dev/additional_info.md. Links include references to the WIKI. * Added a footer to each of the developer specific documents that link to 'Additional Developer Resources'. Now the developer documents are cross-referenced with each other. I have previously made a change to the WIKI home page referencing the developer start page as an entry point into this documentation. Their are other developer specific WIKI pages that could link to Additional Developer Resources. There change is outside the scope of this PR.
Contributions' and distinct link to 'Guidelines for Repository Contributions' added before 'Additional Developer Resources' footer. * Fixed link paths missing the /docs/ prefix before /dev/.
seangoodvibes
approved these changes
Dec 10, 2024
added 2 commits
December 10, 2024 12:08
Merged
via the queue into
SynthstromAudible:community
with commit Dec 10, 2024
45cdc3e
6 checks passed
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.
Added 'Additional Developer Resouces' footer to each of the developer specific documentation. The link to this page reveals a list of other developer documents and relevant references to the WIKI.