openlibhums / openlibhums/memory-alpha
Filename and h1 correspondence
- Dominant language
- Markdown
- Stars
- 0
- Forks
- 0
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 2
Description
Description or user story
Some of the docs filenames are different from the h1s. This is expected for index files, but can cause usability issues with other files, since we sometimes need to use the filename to display the name to the user (capitalizing and changing dashes to spaces).
For example, we might need to do this on the sitemap.
Contributor guide
No contributing guide indexed for this repository
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
Review the documentation filenames and their h1 headings, excluding index files as noted in the issue. Start with the sitemap work referenced in issue #252 and compare the relevant names; done means non-index files have matching filename and h1 correspondence or an explicit exception.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100