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 packagedown documentation #126

Merged
merged 19 commits into from
Jul 14, 2023
Merged

add packagedown documentation #126

merged 19 commits into from
Jul 14, 2023

Conversation

wincowgerDEV
Copy link
Owner

@wincowgerDEV wincowgerDEV commented Dec 22, 2022

Using packagedown to build a nice-looking website and vignettes for the package.

  • Move images to the correct location.
  • Make sure file size of the package isn't impacted by configuration.
  • Update SOP with new functionality and explainations.
  • Update homepage.
  • Customize the website to look its best.
  • Set URL address to something like OpenSpecy.org.

@wincowgerDEV
Copy link
Owner Author

To get the images to work correctly, you cannot have any spaces in the file paths of where the folder with the package is located on your computer.

@wincowgerDEV
Copy link
Owner Author

@wincowgerDEV
Copy link
Owner Author

Issue with local building not being pushed up to the web for some reason. https://stackoverflow.com/questions/69507610/unable-to-push-package-website-pkgdown-from-r-to-github

@wincowgerDEV wincowgerDEV temporarily deployed to github-pages December 23, 2022 14:41 — with GitHub Pages Inactive
@wincowgerDEV
Copy link
Owner Author

This is a bit of a hack now and shouldn't be merged because I am committing the entire docs folder. Unless we can ignore the docs folder when we push to cran. Currently hosted at http://wincowger.com/OpenSpecy-package. We can change the domain to something else if we would like. I currently own openspecy.com or we could use the default github domain I think.

@wincowgerDEV wincowgerDEV temporarily deployed to github-pages December 23, 2022 14:49 — with GitHub Pages Inactive
@wincowgerDEV
Copy link
Owner Author

This is a bit of a hack now and shouldn't be merged because I am committing the entire docs folder. Unless we can ignore the docs folder when we push to cran. Currently hosted at http://wincowger.com/OpenSpecy-package. We can change the domain to something else if we would like. I currently own openspecy.com or we could use the default github domain I think.

Actually probably fine because we have already Rbuildignored that directory.

@wincowgerDEV wincowgerDEV temporarily deployed to github-pages December 24, 2022 12:23 — with GitHub Pages Inactive
@wincowgerDEV wincowgerDEV temporarily deployed to github-pages December 24, 2022 13:13 — with GitHub Pages Inactive
@wincowgerDEV wincowgerDEV temporarily deployed to github-pages December 24, 2022 13:52 — with GitHub Pages Inactive
@wincowgerDEV wincowgerDEV mentioned this pull request Jul 8, 2023
35 tasks
@wincowgerDEV wincowgerDEV temporarily deployed to github-pages July 9, 2023 00:47 — with GitHub Pages Inactive
@wincowgerDEV wincowgerDEV temporarily deployed to github-pages July 9, 2023 04:28 — with GitHub Pages Inactive
@wincowgerDEV wincowgerDEV temporarily deployed to github-pages July 14, 2023 19:51 — with GitHub Pages Inactive
@wincowgerDEV wincowgerDEV merged commit 255c5c7 into v1.0-prep Jul 14, 2023
@wincowgerDEV
Copy link
Owner Author

Merging so that I can more quickly deploy.

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.

1 participant