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

Add docs previews #79

Open
ToucheSir opened this issue Mar 13, 2024 · 2 comments
Open

Add docs previews #79

ToucheSir opened this issue Mar 13, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ToucheSir
Copy link
Member

Motivation and description

This would make (re)viewing docs changes much easier.

Possible Implementation

This has been done for a couple of the larger FluxML repos already. Copying and slightly modifying the configuration from those should be sufficient.

@ToucheSir ToucheSir added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 13, 2024
@Swish78
Copy link

Swish78 commented Jun 12, 2024

Hi @ToucheSir ,

I'd love to contribute to it, but I'm not entirely clear on the specifics of the task. Could you please provide some more details on what needs to be done, especially regarding the configuration that needs to be copied and modified from the other FluxML repositories?

Any guidance or pointers to relevant documentation would be greatly appreciated!

@ToucheSir
Copy link
Member Author

There are 3 main pieces:

  1. Configure documenter and CI to push docs previews. You can see how that works current in Flux and consult the official docs at https://documenter.juliadocs.org/stable/lib/public/#Documenter.deploydocs.
  2. Add a workflow to clean up docs previews. Again, see the existing Flux one and Documenter docs at https://documenter.juliadocs.org/stable/man/hosting/#Cleaning-up-gh-pages.
  3. Add a PR comment workflow like https://github.com/FluxML/Flux.jl/blob/master/.github/workflows/pr_comment.yml.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants