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(docs): Update to latest docs builder, add architecture docs templates #153

Merged
merged 3 commits into from
Nov 24, 2023

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Nov 16, 2023

Description

This PR updates our docs to use the latest docs builder.
This means we no longer have to explicitly create the nav tree, it will be autogenerated from the markdown files in src.
It also enables the documentation building for ADRs which are part of the arc42 Architecture docs added in this PR.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my 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 module

@stevenj stevenj enabled auto-merge (squash) November 21, 2023 04:35
@stevenj stevenj disabled auto-merge November 24, 2023 06:27
@stevenj stevenj merged commit 54bd4ec into main Nov 24, 2023
21 checks passed
@stevenj stevenj deleted the feat/arch-docs branch November 24, 2023 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant