BIRDSOpenSource / BIRDSOpenSource/BIRDS3-ProceduresAndReports
Add "procedure document explainer section" to README
- Dominant language
- No language data
- Stars
- 4
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Go through the procedure documents and add a section to the readme referencing the document and explaining which member of the satellite team may need it, include a brief summary of what the document contains, and any extra thing the user may need to note
You may reference other documents in other repositories within this organisation, e.g for the [assembly procedure](https://github.com/BIRDSOpenSource/BIRDS3-ProceduresAndReports/blob/main/BIRDS-3_AssemblyProcedure_0013_B.docx), you may wan to reference where to find the [CAD files](https://github.com/BIRDSOpenSource/BIRDS3-CAD) to produce the structure first etc.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the repository README and inventory the procedure documents referenced there. For each document, identify the satellite-team member who may need it, summarize its contents, and record any important notes or related resources, such as the linked assembly procedure and CAD repository; done means the README has a useful explainer section covering the procedures.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100