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.

Sign up for GitHub

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

Jump to bottom

Improve runtime documentation #288

Closed
6 tasks done
tsibley opened this issue Jun 1, 2023 · 1 comment · Fixed by #303
Closed
6 tasks done

Improve runtime documentation #288

tsibley opened this issue Jun 1, 2023 · 1 comment · Fixed by #303
Assignees
@tsibley
Labels
documentation Improvements or additions to documentation

Comments

@tsibley
Copy link
Member

tsibley commented Jun 1, 2023 •
edited
Loading

A new "Runtimes" section in the sidebar with new pages:

  • Overview/introduction page
  • Individual runtime pages

The overview/introduction contents may include topics like:

  • "What's a runtime?" (c.f. the CLI install docs, FAQ and glossaries (1, 2))
  • Compare/contrast of runtimes (e.g. a table, the check-setup help)
  • "What commands use runtimes?" (build, shell, view for usage; setup, check-setup, version --verbose for meta)
  • Compatibility guarantees (i.e. none) between different runtimes and between versions of the same runtime.
@tsibley tsibley added the documentation Improvements or additions to documentation label Jun 1, 2023
@tsibley tsibley self-assigned this Jun 1, 2023
@tsibley
Copy link
Member Author

tsibley commented Jun 1, 2023

On my personal todo list and in my notes for a while. Very rough WIP from earlier this year is on trs/docs/runtimes.

Related issues/commentary:

@tsibley tsibley mentioned this issue Jul 5, 2023
Merged
1 task
tsibley added a commit that referenced this issue Aug 3, 2023
@tsibley
docs: Document runtimes more comprehensively and centrally
9e94891 
Trying to provide a more useful resource to point people to than a
smattering of scattered doc snippets.

There's still some places this could be better cross-referenced (e.g. in
--help output) and more that could be said about runtimes in general and
each runtime specifically… but that can all come in due time.  I needed
to find a stopping point for this work _somewhere_.   A big gain here is
that now there's clear places to attach additional documentation in the
future.

Like the recent switch from dynamically- to statically-generated rST for
command documentation, it may also sooner-than-later make sense to ditch
the "automodule" directive and do something static instead.

Resolves <#288>.
@tsibley tsibley mentioned this issue Aug 3, 2023
Merged
4 tasks
@tsibley tsibley mentioned this issue Aug 17, 2023
Open
@tsibley tsibley mentioned this issue Aug 29, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsibley tsibley

Labels
documentation Improvements or additions to documentation
Projects
No open projects
Nextstrain planning (archived)
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improved and expanded runtime documentation nextstrain/cli
1 participant
@tsibley