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 package website and longer form documentation #10

Open
malcolmbarrett opened this issue Oct 8, 2024 · 1 comment
Open

Add package website and longer form documentation #10

malcolmbarrett opened this issue Oct 8, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@malcolmbarrett
Copy link
Contributor

malcolmbarrett commented Oct 8, 2024

You should have a package website for documentation and the like, made with something like pkgdown or altdoc.

You can do this very quickly on GitHub with usethis::use_pkgdown_github_pages()

I would also like to see a vignette (usethis::use_vignette()) or article (usethis::use_article()) with the functionality of the package discussed, similar to the JOSS paper but made for new users or covering advanced topics

openjournals/joss-reviews#7319

PHS-Meantrix added a commit that referenced this issue Oct 20, 2024
make package long form documentation
igor-siciliani added a commit that referenced this issue Oct 20, 2024
@igor-siciliani igor-siciliani self-assigned this Oct 20, 2024
@igor-siciliani igor-siciliani added the documentation Improvements or additions to documentation label Oct 20, 2024
PHS-Meantrix added a commit that referenced this issue Oct 20, 2024
@malcolmbarrett
Copy link
Contributor Author

It looks like your vignette is not being picked up by pkgdown. You might need to add it to the yml file

https://pkgdown.r-lib.org/reference/build_articles.html#index-and-navbar

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

2 participants