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

Docs: Modular docs #182

Merged
merged 2 commits into from
Feb 5, 2022
Merged

Docs: Modular docs #182

merged 2 commits into from
Feb 5, 2022

Conversation

seabbs
Copy link
Contributor

@seabbs seabbs commented Feb 3, 2022

This PR contains a more modular approch to documentation.

In particular it:

  • Removes most of the contents from the README
  • Adds a quick start guide to the readme, installation instructions, contributor instructions, and citation instructioons
  • Renames the main vignette to getting started.
  • Moves the direct scoring documentation into its own vignette
  • Renames the metric detail vignette.

This PR is entirely optional but does represent my personal preference for documentation organisation. In particular the current duplication of documentation seems like it will be dififucult to keep track of.

@seabbs seabbs requested a review from nikosbosse February 3, 2022 16:36
@seabbs seabbs mentioned this pull request Feb 3, 2022
17 tasks
@nikosbosse
Copy link
Contributor

Looks good to me, thank you! It would be nice to link to the pkgdown online vignettes once they are up. By the way: how do you test the pkgdown stuff when it's sitting on a random branch, rather than on main?

@nikosbosse nikosbosse merged commit 04d61ce into major-update Feb 5, 2022
@nikosbosse nikosbosse deleted the docs-getting-started branch February 5, 2022 21:12
@seabbs
Copy link
Contributor Author

seabbs commented Feb 5, 2022

Aha I yolo. It would be pretty easy to change up the action to upload the website as an artefact for checking like this but I haven't seen it in the wild.

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.

2 participants