-
Notifications
You must be signed in to change notification settings - Fork 72
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
Enhance Documentation in README #289
Comments
Perhaps backwards. I have updated the repo settings to refer to the page. GitHub Pages wise, it is set to build from the gh-pages branch's root directory. It's a bit clunky, but does relate to the last release (so it's relevant in the way npm is relevant). Looking at the branch, I was surprised to see it isn't a merge of the docs directory. It's html files generated by this workflow: https://github.com/todogroup/repolinter/blob/main/.github/workflows/docs.yaml - presumably so it can incorporate the apidocs. Presumably documentation.yml also an input. This makes me think it is not the last release but latest content. For example; #227 is deployed, which is after the last release. The index feels clunky - too much content in there as you said. Seems to be concatenating the readme with other pages. |
Issue Report
Documentation is published to GH Pages, but it is poorly advertised within the repository. It is hard to find where to read up on different parts of Repolinter.
Expected Behavior
The text was updated successfully, but these errors were encountered: