NASA-AMMOS / NASA-AMMOS/anms-docs
SLIM integration: Infusion of Lab-approved documentation and templating standards
Nobody has claimed this yet.
- Dominant language
- CMake
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes -- New feature, new files.
Alternatives considered
Yes - This is a Lab-approved and suggested addition to all NASA-AMMOS repositories.
Related problems
Many repos don't provide comprehensive documentation and/or are missing key areas of standardized documentation focus. This feature adds standardized documentation per Lab-approved standards.
Describe the feature request
A number of template and documentation files are being added to the repository in support of the SLIM project. These files are suggested by MGSS and will serve to promote cohesion between NASA-AMMOS products. The files provided are tailored to the current repository with minimal integration assistance and upkeep requested of the CogE and/or developers.
See commit history in the slim_infusion branch for added files.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin by reviewing the slim_infusion branch and its commit history, then compare the added documentation and template files with this repository. Confirm which files are tailored for anms-docs and identify the integration points requiring CogE or developer upkeep. Done means the Lab-approved documentation and templates are added with the requested minimal integration.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100