[New Website Feature]: Improve best practice guide template based on markdown recommendations
Open
Nobody has claimed this yet.
low complexity
requested
website
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes - I've already checked
Alternatives considered
Yes - and alternatives don't suffice
Related problems
@nutjob4life pointed a couple of comments out that our best practice guide template is using some non-ideal best practice for Markdown. Specifically:
- https://github.com/NASA-AMMOS/slim/pull/149#discussion_r1539661884
- https://github.com/NASA-AMMOS/slim/pull/149#discussion_r1539668071
- https://github.com/NASA-AMMOS/slim/pull/149#discussion_r1539679234
- https://github.com/NASA-AMMOS/slim/pull/156#discussion_r1664876952
Describe the feature request
We should evaluate and apply improvements to the template based on Markdown best practices.
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
Start with the “Use our standard guide template” section in the linked contribution guide, then read the Markdown-related discussions in pull requests 149 and 156. Compare the template with current Markdown best practices and apply the agreed improvements. Done means the template reflects those recommendations and the guide renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100