Skip to content

[DOCS] - Better Subdirectory Documentation, Templates #46

Description

@JLefebvre55

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?)

Metadata

Metadata

Assignees

Labels

Priority: HighFeature requires critical attention from all contributorsScope: DocumentationImprovements or additions to documentationStatus: AssignedDevs have been assigned; work not yet startedType: ImprovementModification of existing featureType: New FeatureNew feature

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions