This PR relates to our efforts to restructure all the narrative GGIR documentation #1046
In this PR I am replacing many of the paragraphs in the main CRAN vignette with a link to the new location of the text. In this way external links to CRAN vignette section will keep working, visitors are redirected to the new location, and we avoid having to maintain both new and old documentation.
As part of this:
Added a new vignette GGIRoutput.Rmd with the old overview of 'inspecting the results'
Added GGIRoutput.Rmd and GGIRParameters.Rmd as Annex such that github-pages are more self-sustained with no longer the need to reference CRAN vignettes.
Added household co-analysis vignette to .Rbuildignore, such that it is only available on gh-pages. In this way we minimize the number of vignettes available on CRAN.
Tried to filter search results in search bar from GGIR.html vignette, index.html, and all reference pages for individual functions. Not sure if the latter works, we will see when we merge this PR.
Rebuild the site
Checklist before merging:
[x] Existing tests still work (check by running the test suite, e.g. from RStudio).
[ ] Added tests (if you added functionality) or fixed existing test (if you fixed a bug).
[ ] Clean code has been attempted, e.g. intuitive object names and no code redundancy.
[x] Documentation updated:
[ ] Function documentation
[x] Chapter vignettes for GitHub IO
[x] Vignettes for CRAN
[x] Corresponding issue tagged in PR message. If no issue exist, please create an issue and tag it.
[x] Updated release notes in inst/NEWS.Rd with a user-readable summary. Please, include references to relevant issues or PR discussions.
[ ] Added your name to the contributors lists in the DESCRIPTION file, if you think you made a significant contribution.
[ ] GGIR parameters were added/removed. If yes, please also complete checklist below.
This PR relates to our efforts to restructure all the narrative GGIR documentation #1046
In this PR I am replacing many of the paragraphs in the main CRAN vignette with a link to the new location of the text. In this way external links to CRAN vignette section will keep working, visitors are redirected to the new location, and we avoid having to maintain both new and old documentation.
As part of this:
Checklist before merging:
inst/NEWS.Rdwith a user-readable summary. Please, include references to relevant issues or PR discussions.DESCRIPTIONfile, if you think you made a significant contribution.