Remove all markdown includes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 510
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
When looking at generated pull request previews and diffs from respec, they are not working because we use the markdown include (https://respec.org/docs/#external-includes) which fails because the browser cannot find the markdown file to include when previewing a PR. Fixing this will require pulling the full specification into a single index.html file.
This issue is to track the overall work, but I propose we do this section-by-section to ensure nothing is accidentally changed while making the transition. Doing a single section at a time will also prevent PRs from having to do large conflict resolutions. It will also be a good time to review respec best practices.
Before:
After:
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 by reviewing the Respec external-includes documentation and the current section structure that generates the specification. Work section-by-section toward a single index.html, checking generated pull request previews and diffs after each change. Done means the full specification is included without markdown includes and previews render correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100