Start documentation #15
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a HTML documentation for this software. It's just a start, but includes installation guides, a usage example, a "quickstart" / high-level usage discussion, module/code-level documentation pages, and some outlines for future work.
The latest version has been built and pushed here: https://trailbehind.github.io/changegen, which is where the docs will now live.
This PR adds both the documentation content and infrastructure required to build it. These docs are built with Sphinx, and I've configured a Github Actions workflow to build these docs and push them to Github Pages. This workflow is configured to build new docs whenever a PR is merged into
main.Mainly the opportunities for review here should be regarding the content of the docs. I think we should be trying to assess whether I cover the main points in a way that's decently easy to understand. I'm very open to critques here!