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

Update documentation #99

Merged
merged 2 commits into from
Aug 28, 2024
Merged

Update documentation #99

merged 2 commits into from
Aug 28, 2024

Conversation

b-rowan
Copy link
Contributor

@b-rowan b-rowan commented Aug 27, 2024

Fixes some issues with the github pages docs deployment, and moves some documentation around to hopefully make it a bit more readable.

Had to disable the full check-yaml hook for mkdocs.yml to enable loading environment variables with ENV!.

Fixing an issue with the root level of the github pages deploy not being where mkdocs expects it to be.
Copy link
Collaborator

@tsagadar tsagadar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with my limited understanding in this area.

Main question: will we substantially shorten the README.md once this is deployed and working?

@b-rowan
Copy link
Contributor Author

b-rowan commented Aug 28, 2024

LGTM with my limited understanding in this area.

Main question: will we substantially shorten the README.md once this is deployed and working?

It won't affect the current README, but we may want to update it. I'm not really sure the best way to structure a README vs general documentation, but I'm sure it'll get improved as time goes on.

@b-rowan b-rowan merged commit ed80ee8 into master Aug 28, 2024
2 checks passed
@b-rowan b-rowan deleted the dev_gh_pages branch August 28, 2024 04:33
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.

3 participants