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: initialize mkdocs config and workflow for github pages #315

Merged
merged 4 commits into from
Aug 7, 2024

Conversation

gvauter
Copy link
Member

@gvauter gvauter commented Aug 6, 2024

Description

Adding initial mkdocs-material files for repo documentation. The mkdocs content will be published to Github pages. Future pull requests will update and create the Markdown content for publishing.

Type of change

  • New feature (non-breaking change which adds functionality)

How has this been tested?

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@gvauter gvauter requested a review from jpower432 August 6, 2024 19:41
Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

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

Looks good. Only one change requested on the workflow.

deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Copy link
Member

Choose a reason for hiding this comment

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

These should be pinned to hashes for consistency. Implemented here -#242. Realizing that this should be added to the contributing guide with suggested tools.

Copy link
Member

Choose a reason for hiding this comment

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

Issue added here to make sure the docs are updated #317

@gvauter gvauter requested a review from jpower432 August 7, 2024 11:26
Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

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

LGTM

@gvauter gvauter merged commit 05cfce1 into main Aug 7, 2024
11 checks passed
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