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 technical wishlist #136

Open
3 tasks
ReubenJ opened this issue Feb 25, 2025 · 0 comments
Open
3 tasks

Documentation technical wishlist #136

ReubenJ opened this issue Feb 25, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ReubenJ
Copy link
Member

ReubenJ commented Feb 25, 2025

A couple of ideas have been floating around meetings the last month or two about changes to make to documentation

  • Preview PRs that update documentation—Documenter.jl supports this somehow with the push_preview option
  • If we set up PR previews, we should also set up an action to periodically clean up the gh-pages branch as it's not necessary to keep all of the history around.
  • Publish all versions of documentation. Currently, the only published version is labeled as dev on the site. This looks a bit sloppy and is confusing to new users.
@ReubenJ ReubenJ added the documentation Improvements or additions to documentation label Feb 25, 2025
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