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

Feat: set up docs #24

Merged
merged 3 commits into from
Dec 4, 2024
Merged

Feat: set up docs #24

merged 3 commits into from
Dec 4, 2024

Conversation

lalver1
Copy link
Member

@lalver1 lalver1 commented Dec 4, 2024

Closes #7

This PR sets up the documentation similar to https://github.com/compilerla/template-devcontainer

  • configures mkdocs.yml, based on https://github.com/compilerla/template-devcontainer/blob/main/mkdocs.yml

  • creates a docs/ directory

  • creates docs/requirements.txt with dependencies

    mdx_truly_sane_lists
    mkdocs==1.6.1
    mkdocs-awesome-pages-plugin
    mkdocs-macros-plugin
    mkdocs-material==9.5.44
    mkdocs-redirects
    
  • creates docs/README.md with basic information

  • creates docs Compose service, starts with devcontainer, site is browsable locally

  • creates GitHub Actions workflow that publishes docs to GitHub Pages

@lalver1 lalver1 self-assigned this Dec 4, 2024
@lalver1 lalver1 marked this pull request as ready for review December 4, 2024 15:09
@lalver1 lalver1 requested a review from a team as a code owner December 4, 2024 15:09
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

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

This looks great, I was able to bring up the docs service and website locally without any problems.

I have a suggestion to make this a little nicer inside the devcontainer, but otherwise nice job!

.devcontainer/devcontainer.json Show resolved Hide resolved
@lalver1 lalver1 merged commit 3df8670 into main Dec 4, 2024
1 check passed
@lalver1 lalver1 deleted the feat/docs-setup branch December 4, 2024 21:10
@thekaveman thekaveman added this to the Initial project setup milestone Dec 10, 2024
@thekaveman thekaveman added the documentation Improvements or additions to documentation label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Initial docs setup
2 participants