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

Link mdoc generation tasks to test:compile and release process. #115

Open
paul-a-kennedy-rally opened this issue Jan 3, 2023 · 2 comments

Comments

@paul-a-kennedy-rally
Copy link
Collaborator

The current project (as of 2628c58) has support for docs using the codebase for "live" examples.

There are two use cases for this "live" documentation:

  • It functions as a test and should be maintained as such.
  • It functions as documentation that should be published as part of a release.

This issue is to link the mdoc generation process to testing and to documentation release.

@jeffmay
Copy link
Owner

jeffmay commented Jan 6, 2023

I was thinking we could create a pre-commit hook / CI check that the documents are regenerated (excluding timestamps, somehow) when the source doc file changes.

@paul-a-kennedy-rally
Copy link
Collaborator Author

I think that the point is to ensure that the running code within the documentation keeps pace with the source code.

Ensuring that this code is a first class citizen is to ensure that code in the documentation actually compiles and is not left as an afterthought.

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

2 participants