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

Continually update model specification section #123

Open
iantaylor-NOAA opened this issue Feb 9, 2024 · 1 comment
Open

Continually update model specification section #123

iantaylor-NOAA opened this issue Feb 9, 2024 · 1 comment
Assignees
Labels
kind: developer handbook update describes a new component of or change to developer book theme: documentation Improvements or additions to documentation
Milestone

Comments

@iantaylor-NOAA
Copy link
Contributor

Any changes in model specification associated with MQ should be added to the https://github.com/NOAA-FIMS/collaborative_workflow/blob/main/03-M1-model-specification.Rmd file (will be renamed as part of #116).

@iantaylor-NOAA iantaylor-NOAA added theme: documentation Improvements or additions to documentation kind: developer handbook update describes a new component of or change to developer book labels Feb 9, 2024
@iantaylor-NOAA iantaylor-NOAA added this to the M2 milestone Feb 9, 2024
@Bai-Li-NOAA Bai-Li-NOAA self-assigned this Mar 11, 2024
@Bai-Li-NOAA
Copy link
Contributor

Bai-Li-NOAA commented May 2, 2024

Following the agile documentation philosophy, the group is considering removing the model specification chapter from the developer's handbook. The proposal is to use Doxygen to publish equations with the source code, thereby avoiding the need to update equations in multiple locations. We plan to use design docs to document significant design decisions and archive them at the end of each milestone. The backup plan would be to continue working on the model specification chapter if we can't find a better way to navigate the Doxygen website.

Additionally, the group received feedback on adopting the Stan approach, which involves having separate components: (1) a user's guide containing clear implementation examples, (2) a reference manual providing background on model structure and syntax, and (3) a function reference offering more in-depth material of interest to a smaller subset of users.

Tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: developer handbook update describes a new component of or change to developer book theme: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants