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

Integrate mdbook-template with the guide #2605

Closed
7 tasks
seanchen1991 opened this issue Aug 31, 2022 · 0 comments · Fixed by #2625
Closed
7 tasks

Integrate mdbook-template with the guide #2605

seanchen1991 opened this issue Aug 31, 2022 · 0 comments · Fixed by #2625
Milestone

Comments

@seanchen1991
Copy link
Contributor

seanchen1991 commented Aug 31, 2022

Summary

Make it easier to keep the guide in sync with the code base by taking advantage of mdbook anchors and mdbook-template in order to integrate code snippets and files into the guide.

Problem Definition and Proposal

Keeping the guide in sync with the code base is currently an extremely manual process. This can be somewhat alleviated by taking advantage of mdbook anchors and mdbook-template in order to integrate code snippets and files into the guide. These files can then be checked and validated via a CI job on every PR to ensure that the snippets and files are kept up-to-date.

Acceptance Criteria

  • Use mdbook templates in the Commands Reference section of the guide
  • Validate these files and code snippets on every PR with a CI job.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
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

Successfully merging a pull request may close this issue.

2 participants