-
Notifications
You must be signed in to change notification settings - Fork 649
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: moving docs to pages #3633
Conversation
336c95e
to
c8a0604
Compare
the reorganization is looking very nice. when possible it's probably better not to hard-code full URLs such as "https://philips-labs.github.io/terraform-aws-github-runner/modules/public/ami-housekeeper/" if documentation is referring to itself it could use a relative path. |
Minor spelling issue: Introduciton -> Introduction For each page of text if you quickly copy-paste it into Gmail, that has a built-in spell checker and will suggest what should be fixed. At least with paragraphs of written content. Maybe it skips formatted YAML documents, and so won't catch everything. |
would be much better, but it is hard to link from both the docs side and the readme's correctly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor changes, this is a welcoming change.
Pages branch set to gh-pages |
The documentation in our README have become quite extensive over the years. This PR is moving docs including examples and modules to a documentation site. The top-level readme is shrinked down to some basic / essential information.
For examples and module documentation sources in example and module directories are linked.