BIRDSOpenSource / BIRDSOpenSource/BIRDS5-Procedures_Reports
Add "procedure document explainer" section to README
- Dominant language
- No language data
- Stars
- 1
- Forks
- 0
- 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/BIRDS5-Procedures_Reports/tree/main/Assembly%20Procedure), you may wan to reference where to find the [CAD files](https://github.com/BIRDSOpenSource/BIRDS5-CAD) to produce the structure first etc.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the procedure documents in this repository and the existing README, then check the linked Assembly Procedure and BIRDS5-CAD repository for related references. Done means the README has a procedure-document explainer section identifying the relevant satellite-team member, summarizing each document, and noting any extra information users need.
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
- 45/100