Skip to content

Reorganize project documentation#15308

Merged
seanbudd merged 1 commit into
masterfrom
reorgDocs
Aug 24, 2023
Merged

Reorganize project documentation#15308
seanbudd merged 1 commit into
masterfrom
reorgDocs

Conversation

@seanbudd

Copy link
Copy Markdown
Member

This PR reorganizes the "devDocs" folder of project documentation.
The proposed structure is as follow:

  • projectDocs
    • product_vision.md
    • design (for product design and technical design overviews)
    • dev (for development and contributing docs)
      • developerGuide
    • issues (for issue reporting and triage)

Testing

Tested the following scons commands:

  • scons developerGuide
  • scons devDocs
  • scons devDocs_nvdaHelper

@seanbudd seanbudd requested a review from a team as a code owner August 18, 2023 07:01
@michaelDCurran

Copy link
Copy Markdown
Member

I'm worried that some of these files are already widely linked to on other websites or are depended on by other 3rd parties. E.g. the HID braille article.
Can you explain how the positives of this restructure would outweigh breaking existing links?

@seanbudd seanbudd merged commit 7653056 into master Aug 24, 2023
@seanbudd seanbudd deleted the reorgDocs branch August 24, 2023 04:25
@nvaccessAuto nvaccessAuto added this to the 2023.3 milestone Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants