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

Keep code and developer documentation in the visioneval code tree #24

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

Keep code and developer documentation in the visioneval code tree #24

jrawbits opened this issue Mar 26, 2024 · 0 comments

Comments

@jrawbits
Copy link
Contributor

Documentation that may be upset by changes in the code tree needs to be maintained in the code tree.

That means creating R code (executed by .Rmd when the book is rendered, but probably also pre-populated through a build function that knows about the documentation book specifically) that will pull out module_docs, input file descriptive information, model estimation information, etc.

Each package and module should have better-structured documentation that gets sucked up into detailed, well-linked appendices in the documentation book.

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