search

U-Shift / biclar

Strategic cycle network planning tools, evidence and reproducible code
https://u-shift.github.io/biclar/
GNU Affero General Public License v3.0
4 stars 3 forks source link

Documentation #14

Closed temospena closed 1 year ago

temospena commented 2 years ago

I'd like start organizing a kind of a github pages website to have the documentation on the used methods, so that I don't get lost and know what/how was done in the future. Something todo.

temospena commented 2 years ago

@Robinlovelace help needed only to setup github pages :)

Robinlovelace commented 2 years ago

Sounds good. First up, can we change the repo name to just biclar? easier to install that way...

Robinlovelace commented 2 years ago

After that it may be as simple as running the following command, just checked on the new si package, thanks to Jakub for the tip!

usethis::use_pkgdown_github_pages()
Robinlovelace commented 2 years ago

Let me know how you get on @temospena I can try here if you have any issues.

temospena commented 2 years ago

After that it may be as simple as running the following command, just checked on the new si package, thanks to Jakub for the tip!

usethis::use_pkgdown_github_pages()

Perfect, I'll change the name and try this out!

temospena commented 2 years ago

usethis::use_pkgdown_github_pages() √ Setting active project to 'D:/GIS/TML/bicla-R' Error: use_pkgdown() is designed to work with packages. Project 'bicla-R' is not an R package.

Does it changes a lot of things it it becomes a pkg? Or is better to use other feature?

Robinlovelace commented 2 years ago

Does it changes a lot of things it it becomes a pkg? Or is better to use other feature?

Good question, I would say that no it does not change a lot, and that the pros of making it a package are fairly big. Alternatives including creating a blogdown site but, as we already know how to make pkg websites (not least with the slopes pkg that I really want to get on CRAN!) it should be quicker this way. We can always ignore 'non package' files and directories with usethis::use_build_ignore().

temospena commented 2 years ago

Ok! So, when stating a package, which registry should I follow? I'm sorry, maybe it is better latter to setup a quick chat.

temospena commented 2 years ago

We have a website and documentation! 🎉 https://u-shift.github.io/biclar/

To create new articles (not the same as vignettes) usethis::use_article()

Robinlovelace commented 2 years ago

Great to see! I think this issue is fixed :+1: