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

Documentation plan #11

Open
7 tasks
jcurtis2 opened this issue Jun 28, 2024 · 0 comments
Open
7 tasks

Documentation plan #11

jcurtis2 opened this issue Jun 28, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jcurtis2
Copy link
Member

jcurtis2 commented Jun 28, 2024

Documentation plan to use Markdown.

  • Add documentation in the source code using doxygen

    • Emissions
    • Boundary conditions
    • Initial conditions
  • Set up github actions to auto-generate the doxygen and upload to GitHub pages website

    • Landing page for documentation - describe project, linking to papers (paragraph about each key paper) and link to doxygen
  • Write an outline regarding all the parts of WRF-PartMC that need to be explained. These should either go into papers or require an explanation elsewhere on the docs website.

Notes about documentation: https://docs.divio.com/documentation-system/

@jcurtis2 jcurtis2 self-assigned this Sep 18, 2024
@jcurtis2 jcurtis2 added the documentation Improvements or additions to documentation label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant