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 documentation and website #17

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

statnmap
Copy link

Thank you for your package.
To allow a broader use, I suggest to make sure the checks are ok, and a minimum documentation is available.

You will find modifications in this PR:

  • All checks are good
  • A readme.Rmd with explanation on how to set up the API
  • A readme.Rmd with a first example
  • An update of dependencies in DESCRIPTION using attachment::att_amend_desc() to allow installation of the package with its dependencies
  • A set up of GitHub Actions to check automatically each commit
  • A set up of GitHub Actions to serve a pkgdown website (as demanded in Any plans to create a pakgdown documentation site? #16)
    • To make it available after you accept the PR, you will have to go in : Settings > Pages > Deploy from a branch : gh-pages : Root > Save
    • You will then see the website there I guess : https://Eflores89.github.io/notionR/
  • A "dev/" directory with the main functions used to set all these steps

Do not hesitate to ask me questions about theses changes if you want.

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.

None yet

1 participant