Skip to content

Documentation improvements#9

Draft
itafraze wants to merge 3 commits into
JuliaAPlavin:masterfrom
itafraze:feature/generate-the-project-documentation
Draft

Documentation improvements#9
itafraze wants to merge 3 commits into
JuliaAPlavin:masterfrom
itafraze:feature/generate-the-project-documentation

Conversation

@itafraze

Copy link
Copy Markdown

I thought it would be nice to have some documentation site hosted on GitHub Pages.
WIP: draft docstrings generated with LLM; to be verified

itafraze added 2 commits June 10, 2026 17:47
Signed-off-by: Emanuele Zarfati <itafraze@mf.me>
Signed-off-by: Emanuele Zarfati <itafraze@mf.me>
@itafraze itafraze force-pushed the feature/generate-the-project-documentation branch from 0651eff to 4d7ef60 Compare June 10, 2026 15:49
@aplavin

aplavin commented Jun 10, 2026

Copy link
Copy Markdown
Member

Docstrings: totally agree, makes sense to add more of those!
Github pages etc: my general preference is to avoid/minimize dependency on github-specific features, and make a plain repo clone have everything needed, in the same shape, as the online version. For docs it means handling them in the most native way – docstrings + readme.

This reverts commit 4d7ef60.
@itafraze itafraze changed the title Set-up documentation with Documenter.jl Documentation improvements Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants