You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
For Admin Use
The text was updated successfully, but these errors were encountered: