BIRDSOpenSource / BIRDSOpenSource/BIRDS4-ProceduresAndReports

Add "procedure document explainer" section to README

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
No language data
Stars
0
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/BIRDS4-ProceduresAndReports/blob/main/Procedures/BIRDS4-FM%20Assembly%20Procedure.docx), you may wan to reference where to find the [CAD files](https://github.com/BIRDSOpenSource/BIRDS4-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 current README. Add a README section for each procedure that identifies the relevant satellite-team member, briefly summarizes the document, and notes anything users should know. Include useful cross-references such as the assembly procedure's CAD-files repository, and consider the work done when all procedure documents are represented.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.