Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] - Better Subdirectory Documentation, Templates #46

Open
11 tasks
JLefebvre55 opened this issue Jun 24, 2021 · 0 comments
Open
11 tasks

[DOCS] - Better Subdirectory Documentation, Templates #46

JLefebvre55 opened this issue Jun 24, 2021 · 0 comments
Assignees
@JLefebvre55
Labels
Priority: High Feature requires critical attention from all contributors Scope: Documentation Improvements or additions to documentation Status: Assigned Devs have been assigned; work not yet started Type: Improvement Modification of existing feature Type: New Feature New feature

Comments

@JLefebvre55
Copy link
Member

JLefebvre55 commented Jun 24, 2021 •
edited
Loading

READMEs and other docs for each of the major subdirectories would make navigation and understanding easier. In addition, adding structural templates for each subsystem would be useful.

Context

Currently tough to get around, and is probably not as good an open-source project as it could be.

  • READMEs - What is this folder? What does it contain? What's it's structural pattern?
    • Documentation /docs/
    • Deliverables /deliverables/
  • Subsystem Template - matches root structure
    • Hardware hardware/
    • Software software/
    • README - Structure matches functional components of base README, plus:
      • Function (purpose, integration)
      • Implementation (assembly, installation)
      • Testing (protocols, proof of validation)
  • #65

Additional context
This will eventually be adapted to our wikis (I think?)
@JLefebvre55 JLefebvre55 added Scope: Documentation Improvements or additions to documentation Status: Open Anybody may contribute to this feature Type: New Feature New feature Type: Improvement Modification of existing feature labels Jun 24, 2021
@JLefebvre55 JLefebvre55 changed the title [DOCS] - Better Subdirectory Documentation [DOCS] - Better Subdirectory Documentation, Templates Jun 27, 2021
@JLefebvre55 JLefebvre55 self-assigned this Aug 1, 2021
@JLefebvre55 JLefebvre55 pinned this issue Aug 1, 2021
@JLefebvre55 JLefebvre55 added Priority: High Feature requires critical attention from all contributors Status: Assigned Devs have been assigned; work not yet started and removed Status: Open Anybody may contribute to this feature labels Aug 1, 2021
@JLefebvre55 JLefebvre55 unpinned this issue Aug 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JLefebvre55 JLefebvre55

Labels
Priority: High Feature requires critical attention from all contributors Scope: Documentation Improvements or additions to documentation Status: Assigned Devs have been assigned; work not yet started Type: Improvement Modification of existing feature Type: New Feature New feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JLefebvre55