Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove all markdown includes #562

Open
dyladan opened this issue Mar 26, 2024 · 0 comments
Open

Remove all markdown includes #562

dyladan opened this issue Mar 26, 2024 · 0 comments

Comments

@dyladan
Copy link
Member

dyladan commented Mar 26, 2024

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:
image

After:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant