From 8262fbd7114a0ce2fd3b5f1e29b2ae07aa381d81 Mon Sep 17 00:00:00 2001 From: Steven Johnson Date: Wed, 8 Nov 2023 15:35:36 +0700 Subject: [PATCH] feat(docs): Add documentation/gh-pages using Catalyst-CI docs builders and actions. (#104) * refactor(gateway): Rename catalyst-voices-backend to the catalyst-gateway * docs(gateway): Update readme * refactor(gateway): Move the code into the new directory trees, cleanup inside tree still todo. * refactor(gateway): Basic refactor of the event-db config/data and the db interface logic * docs(gateway): Initial docs for the crates directory inside catalyst gateway * refactor(gateway): Move code out of cat-data-service and put it directly in bin * feat(gateway): first build seems to work, but fails due to WIP refactor * refactor(gateway): Refactor builds properly to a static executable. * refactor(gateway): autofixed lints * refactor(gateway): WIP remove lint errors * refactor(gateway): WIP refactoring work to remove lint errors * refactor(gateway): Don't panic, return the error, and generalize the error itself. * refactor(gateway): generalize error response * docs(gateway): indexing ok here, slice already checked to have values * refactor(gateway): Indexing is safe here, so note it. * refactor(gateway): don't panic, return an error. reduce size of function by splitting into multiple logical units. * refactor(gateway): Purge metrics from legacy service. Unused and can panic. * refactor(gateway): remove unused rust files from EventDB directory * refactor(gateway): remove unused dependencies * docs(gateway): Allow intentional panic for test code * refactor(gateway): eliminate or notate why unwraps/expect are safe * refactor(gateway): All lints are clean and restrictively applied * refactor(gateway): remove unused dependencies from workspace cargo file * refactor(gateway): restrict visibility of event_db to pub(crate) as its fully internalized now. * docs(gateway): root level fully documented * docs(gateway): state fully documented * docs(gateway): Don't worry about full docs for legacy service. * docs(gateway): Service top level fully documented * docs(gateway): middleware docs complete * docs(gateway): Fully documented the docs part of the service * docs(gateway): common responses and module root fully documented * docs(gateway): Common objects now fully documented * docs(gateway): Api endpoint docs are complete * docs(gateway): DB Types fully documented * docs(gateway): Queries partially documented * docs(gateway): Everything that needs docs is documented * feat(gateway): Initial CI and Cat-Gateway build ready for PR * feat(rust): Add recommended rust extensions for vscode, and rust settings. * docs(gateway): Fix spelling * ci(gateway): Use the proper versioned CI tooling from catalyst-ci * feat(docs): Docs WIP setup * docs(docs): Fix the docs so they use the latests docs-ci and are able to properly include data from build targets * docs(docs): fix spelling and markdown lint issues * docs(docs): Update to use latest Cat-CI Docs and reduce replication * docs(docs): Fix the top level parts of the docs and remove test values * docs(docs): try and build and deploy docs to gh-pages * docs(docs): fix spelling issue * docs(docs): Use proper docs action, and also add branch cleanup for branch docs * docs(docs): Use the published versions from Catalyst-CI * docs(docs): Ensure we do not try and clean docs while building them. * docs(docs): Ensure we don't try and build docs simultaneously, Don't build docs for tags. * ci(mdlint): Use tagged CI versions for stability * ci(spelling): Use tagged CI versions for stability --- .config/dictionaries/project.dic | 3 + .github/workflows/branch-delete-cleanup.yml | 13 ++++ .github/workflows/docs.yml | 30 ++++++++ .github/workflows/markdown-check.yml | 2 +- .github/workflows/spell-check.yml | 2 +- .gitignore | 6 ++ .vscode/settings.recommended.json | 19 ++++- Earthfile | 10 ++- docs/Earthfile | 29 ++++++++ docs/mkdocs.yml | 41 +++++++++++ docs/src/appendix/important/coc.md | 7 ++ docs/src/appendix/important/contributing.md | 7 ++ docs/src/appendix/important/index.md | 5 ++ docs/src/appendix/important/license.md | 19 +++++ docs/src/appendix/important/security.md | 7 ++ docs/src/appendix/index.md | 7 ++ .../catalyst-standards/ballot/catalyst-v1.md | 6 ++ .../catalyst-standards/ballot/catalyst-v2.md | 6 ++ docs/src/catalyst-standards/ballot/index.md | 6 ++ .../catalyst-standards/draft-cips/.meta.yml | 2 + .../.meta.yml | 1 + .../cip-xxxx.md | 69 +++++++++++++++++++ .../catalyst-standards/draft-cips/index.md | 6 ++ .../draft-cips/rbac-cip30-extension/.meta.yml | 1 + .../rbac-cip30-extension/cip-xxxx.md | 69 +++++++++++++++++++ .../draft-cips/role-registration/.meta.yml | 1 + .../draft-cips/role-registration/cip-xxxx.md | 69 +++++++++++++++++++ docs/src/catalyst-standards/index.md | 6 ++ docs/src/getting-started/advanced.md | 5 ++ docs/src/getting-started/development.md | 5 ++ docs/src/getting-started/index.md | 5 ++ docs/src/getting-started/quick-start.md | 5 ++ docs/src/important/coc.md | 5 ++ docs/src/important/contributing.md | 5 ++ docs/src/important/index.md | 5 ++ docs/src/important/license.md | 15 ++++ docs/src/important/security.md | 5 ++ docs/src/index.md | 10 +++ docs/src/monorepo-architecture/index.md | 6 ++ 39 files changed, 516 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/branch-delete-cleanup.yml create mode 100644 .github/workflows/docs.yml create mode 100644 docs/Earthfile create mode 100644 docs/mkdocs.yml create mode 100644 docs/src/appendix/important/coc.md create mode 100644 docs/src/appendix/important/contributing.md create mode 100644 docs/src/appendix/important/index.md create mode 100644 docs/src/appendix/important/license.md create mode 100644 docs/src/appendix/important/security.md create mode 100644 docs/src/appendix/index.md create mode 100644 docs/src/catalyst-standards/ballot/catalyst-v1.md create mode 100644 docs/src/catalyst-standards/ballot/catalyst-v2.md create mode 100644 docs/src/catalyst-standards/ballot/index.md create mode 100644 docs/src/catalyst-standards/draft-cips/.meta.yml create mode 100644 docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/.meta.yml create mode 100644 docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md create mode 100644 docs/src/catalyst-standards/draft-cips/index.md create mode 100644 docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/.meta.yml create mode 100644 docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md create mode 100644 docs/src/catalyst-standards/draft-cips/role-registration/.meta.yml create mode 100644 docs/src/catalyst-standards/draft-cips/role-registration/cip-xxxx.md create mode 100644 docs/src/catalyst-standards/index.md create mode 100644 docs/src/getting-started/advanced.md create mode 100644 docs/src/getting-started/development.md create mode 100644 docs/src/getting-started/index.md create mode 100644 docs/src/getting-started/quick-start.md create mode 100644 docs/src/important/coc.md create mode 100644 docs/src/important/contributing.md create mode 100644 docs/src/important/index.md create mode 100644 docs/src/important/license.md create mode 100644 docs/src/important/security.md create mode 100644 docs/src/index.md create mode 100644 docs/src/monorepo-architecture/index.md diff --git a/.config/dictionaries/project.dic b/.config/dictionaries/project.dic index 93317b10a5..35ad3b30be 100644 --- a/.config/dictionaries/project.dic +++ b/.config/dictionaries/project.dic @@ -1,6 +1,7 @@ aarch addrr adminer +asyncio auditability BROTLI cardano @@ -26,6 +27,8 @@ Intellij jetbrains jorm jormungandr +Jörmungandr +kroki lcov Leshiy localizable diff --git a/.github/workflows/branch-delete-cleanup.yml b/.github/workflows/branch-delete-cleanup.yml new file mode 100644 index 0000000000..486849acc3 --- /dev/null +++ b/.github/workflows/branch-delete-cleanup.yml @@ -0,0 +1,13 @@ +name: Branch Deleted + +on: delete + +concurrency: + group: "docs" + cancel-in-progress: false + +jobs: + delete: + name: On branch deleted + if: github.event.ref_type == 'branch' + uses: input-output-hk/catalyst-ci/.github/workflows/branch-delete-cleanup.yml@v2.0.6 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000000..b45a840d89 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ +name: Docs + +# cspell: words earthfile + +on: + push: + tags-ignore: + - "*" + +concurrency: + group: "docs" + cancel-in-progress: false + +permissions: + id-token: write + contents: write + packages: write + +jobs: + ci: + uses: input-output-hk/catalyst-ci/.github/workflows/pages.yml@v2.0.6 + with: + aws_role_arn: arn:aws:iam::332405224602:role/ci + aws_region: eu-central-1 + ci_cli_version: 1.3.1 + earthfile: ./docs + target: docs + secrets: + earthly_runner_address: ${{ secrets.EARTHLY_SATELLITE_ADDRESS }} + earthly_runner_secret: ${{ secrets.EARTHLY_RUNNER_SECRET }} diff --git a/.github/workflows/markdown-check.yml b/.github/workflows/markdown-check.yml index 2b210bfd12..9895ac58db 100644 --- a/.github/workflows/markdown-check.yml +++ b/.github/workflows/markdown-check.yml @@ -11,4 +11,4 @@ on: jobs: build: name: Check markdown files formatted consistently - uses: input-output-hk/catalyst-ci/.github/workflows/markdown-check.yml@master + uses: input-output-hk/catalyst-ci/.github/workflows/markdown-check.yml@v2.0.6 diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index f04737bbb5..97bb1952fb 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -11,4 +11,4 @@ on: jobs: build: name: Check spelling across all files - uses: input-output-hk/catalyst-ci/.github/workflows/spell-check.yml@master + uses: input-output-hk/catalyst-ci/.github/workflows/spell-check.yml@v2.0.6 diff --git a/.gitignore b/.gitignore index aa5156755d..cad209d511 100644 --- a/.gitignore +++ b/.gitignore @@ -78,3 +78,9 @@ $RECYCLE.BIN/ !/.vscode/launch.recommended.json !/.vscode/settings.recommended.json !/.vscode/tasks.recommended.json + +# Local only development artefacts can get installed here. +/local + +# We only want the actual document source from this directory. +/docs/site/ diff --git a/.vscode/settings.recommended.json b/.vscode/settings.recommended.json index c46b2ec7f5..b532dac40d 100644 --- a/.vscode/settings.recommended.json +++ b/.vscode/settings.recommended.json @@ -4,7 +4,8 @@ "editor.codeActionsOnSave": { "source.organizeImports": true, "source.sortMembers": true, - "source.fixAll": true + "source.fixAll": true, + "source.fixAll.markdownlint": true }, "files.autoSave": "afterDelay", "editor.formatOnType": true, @@ -55,6 +56,22 @@ "-c", "cargo lint-vscode" ], + "yaml.schemas": { + "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" + }, + "yaml.customTags": [ + "!ENV scalar", + "!ENV sequence", + "tag:yaml.org,2002:python/name:materialx.emoji.to_svg", + "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", + "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" + ], + "[markdown]": { + "editor.formatOnSave": true, + "editor.formatOnPaste": true, + "files.trimTrailingWhitespace": true, + "editor.defaultFormatter": "DavidAnson.vscode-markdownlint" + }, "rust-analyzer.rustfmt.extraArgs": [ "+nightly" ], diff --git a/Earthfile b/Earthfile index 99613f2f90..4cde7aeba3 100644 --- a/Earthfile +++ b/Earthfile @@ -22,4 +22,12 @@ spell-check: LOCALLY DO github.com/input-output-hk/catalyst-ci/earthly/cspell:v1.3.0+CSPELL_LOCALLY --src=$(echo ${PWD}) - \ No newline at end of file + +repo-docs: + # Create artifacts of extra files we embed inside the documentation when its built. + FROM scratch + + WORKDIR /repo + COPY --dir *.md LICENSE-APACHE LICENSE-MIT . + + SAVE ARTIFACT /repo repo diff --git a/docs/Earthfile b/docs/Earthfile new file mode 100644 index 0000000000..9b34015859 --- /dev/null +++ b/docs/Earthfile @@ -0,0 +1,29 @@ +# Set the Earthly version to 0.7 +VERSION 0.7 + +# cspell: words mkdocs runable + +# Copy all the source we need to build the docs +src: + # Common src setup + DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.5+SRC + + # Now copy into that any artifacts we pull from the builds. + COPY --dir ../+repo-docs/repo /docs/includes + +# Build the docs here. +docs: + FROM +src + + DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.5+BUILD + +# Make a locally runable container that can serve the docs. +local: + # Build a self contained service to show built docs locally. + DO github.com/input-output-hk/catalyst-ci/earthly/docs:v2.0.5+PACKAGE + + # Copy the static pages into the container + COPY +docs/ /usr/share/nginx/html + + # This is a local only image, we do not publish it. + SAVE IMAGE cat-voices-docs:latest \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000000..a0a3924e86 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,41 @@ +INHERIT: std-theme.yml + +# cspell: words cips + +# Project Information +site_name: Project Catalyst - Catalyst Voices +site_url: https://input-output-hk.github.io/catalyst-docs + +# Repository +repo_name: input-output-hk/catalyst-voices +repo_url: https://github.com/input-output-hk/catalyst-voices + +# Page tree +nav: + - Home: index.md + - Getting Started: + - Getting Started: getting-started/index.md + - Quick Start: getting-started/quick-start.md + - Advanced: getting-started/advanced.md + - Development: getting-started/development.md + - Monorepo Architecture: + - Monorepo Architecture: monorepo-architecture/index.md + - Catalyst Standards: + - Catalyst Standards: catalyst-standards/index.md + - Draft CIPs: + - Draft CIPs: catalyst-standards/draft-cips/index.md + - Role Registration: catalyst-standards/draft-cips/role-registration/cip-xxxx.md + - RBAC CIP30 Extension: catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md + - Catalyst Voting CIP30 Extension: catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md + - Catalyst Ballot Formats: + - Catalyst Ballot Formats: catalyst-standards/ballot/index.md + - Catalyst V1 Ballot: catalyst-standards/ballot/catalyst-v1.md + - Catalyst V2 Ballot: catalyst-standards/ballot/catalyst-v2.md + - Appendix: + - Appendix: appendix/index.md + - Important Information: + - Important Information: appendix/important/index.md + - Contributing: appendix/important/contributing.md + - Code of Conduct: appendix/important/coc.md + - Security: appendix/important/security.md + - License: appendix/important/license.md diff --git a/docs/src/appendix/important/coc.md b/docs/src/appendix/important/coc.md new file mode 100644 index 0000000000..95610f557e --- /dev/null +++ b/docs/src/appendix/important/coc.md @@ -0,0 +1,7 @@ +--- +icon: material/file-sign +--- + + + +{{ include_file('includes/repo/CODE_OF_CONDUCT.md') }} diff --git a/docs/src/appendix/important/contributing.md b/docs/src/appendix/important/contributing.md new file mode 100644 index 0000000000..fcce80fe55 --- /dev/null +++ b/docs/src/appendix/important/contributing.md @@ -0,0 +1,7 @@ +--- +icon: material/pen-plus +--- + + + +{{ include_file('includes/repo/CONTRIBUTING.md') }} diff --git a/docs/src/appendix/important/index.md b/docs/src/appendix/important/index.md new file mode 100644 index 0000000000..df6e9085fb --- /dev/null +++ b/docs/src/appendix/important/index.md @@ -0,0 +1,5 @@ +--- +icon: material/alert-decagram-outline +--- + +# Important diff --git a/docs/src/appendix/important/license.md b/docs/src/appendix/important/license.md new file mode 100644 index 0000000000..5e2fef6e27 --- /dev/null +++ b/docs/src/appendix/important/license.md @@ -0,0 +1,19 @@ +--- +icon: material/license +--- + +# License + + + +??? note "Apache 2 License" + + ```text + {{ include_file('includes/repo/LICENSE-APACHE', 0, -1, 8) }} + ``` + +??? note "MIT License" + + ```text + {{ include_file('includes/repo/LICENSE-MIT', 0, -1, 8) }} + ``` diff --git a/docs/src/appendix/important/security.md b/docs/src/appendix/important/security.md new file mode 100644 index 0000000000..fd86f01d61 --- /dev/null +++ b/docs/src/appendix/important/security.md @@ -0,0 +1,7 @@ +--- +icon: material/security +--- + + + +{{ include_file('includes/repo/SECURITY.md') }} diff --git a/docs/src/appendix/index.md b/docs/src/appendix/index.md new file mode 100644 index 0000000000..53e1f39cfc --- /dev/null +++ b/docs/src/appendix/index.md @@ -0,0 +1,7 @@ +--- +icon: material/file-document-plus-outline +--- + +# Appendix + +The appendix contains collections of extra information and examples relevant to Catalyst Voices. diff --git a/docs/src/catalyst-standards/ballot/catalyst-v1.md b/docs/src/catalyst-standards/ballot/catalyst-v1.md new file mode 100644 index 0000000000..3aeab01037 --- /dev/null +++ b/docs/src/catalyst-standards/ballot/catalyst-v1.md @@ -0,0 +1,6 @@ +--- +icon: material/ballot +--- + + +# Catalyst Ballot Format V1 diff --git a/docs/src/catalyst-standards/ballot/catalyst-v2.md b/docs/src/catalyst-standards/ballot/catalyst-v2.md new file mode 100644 index 0000000000..31432f62ec --- /dev/null +++ b/docs/src/catalyst-standards/ballot/catalyst-v2.md @@ -0,0 +1,6 @@ +--- +icon: material/ballot-outline +--- + + +# Catalyst Ballot Format V2 diff --git a/docs/src/catalyst-standards/ballot/index.md b/docs/src/catalyst-standards/ballot/index.md new file mode 100644 index 0000000000..662a3d45e6 --- /dev/null +++ b/docs/src/catalyst-standards/ballot/index.md @@ -0,0 +1,6 @@ +--- +icon: material/ballot-recount-outline +--- + + +# Catalyst Ballot Formats diff --git a/docs/src/catalyst-standards/draft-cips/.meta.yml b/docs/src/catalyst-standards/draft-cips/.meta.yml new file mode 100644 index 0000000000..28745ae4b9 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/.meta.yml @@ -0,0 +1,2 @@ +status: new +template: cip.html diff --git a/docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/.meta.yml b/docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/.meta.yml new file mode 100644 index 0000000000..18a4fcdf33 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/.meta.yml @@ -0,0 +1 @@ +icon: material/vote-outline diff --git a/docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md b/docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md new file mode 100644 index 0000000000..066f2e2272 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/catalyst-vote-signing-cip30-extension/cip-xxxx.md @@ -0,0 +1,69 @@ +--- +CIP: /? +Title: Role based Access Control Registration +Category: MetaData +Status: Proposed +Authors: + - Steven Johnson +Implementors: [] +Discussions: + - https://github.com/cardano-foundation/cips/pulls/? +Created: 2023-10-24 +License: CC-BY-4.0 +--- + + + + +# Role Based Access Control Registration + +## Abstract + + +## Motivation: why is this CIP necessary? + + +## Specification + + +## Rationale: how does this CIP achieve its goals? + + +## Path to Active + +### Acceptance Criteria + + +### Implementation Plan + + +## Copyright + diff --git a/docs/src/catalyst-standards/draft-cips/index.md b/docs/src/catalyst-standards/draft-cips/index.md new file mode 100644 index 0000000000..26ec0f8fd0 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/index.md @@ -0,0 +1,6 @@ +--- +icon: material/pencil-box-multiple-outline +--- + + +# Draft CIPs diff --git a/docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/.meta.yml b/docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/.meta.yml new file mode 100644 index 0000000000..4c831482e1 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/.meta.yml @@ -0,0 +1 @@ +icon: material/account-check diff --git a/docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md b/docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md new file mode 100644 index 0000000000..569f48955e --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/rbac-cip30-extension/cip-xxxx.md @@ -0,0 +1,69 @@ +--- +CIP: /? +Title: Role based Access Control Registration +Category: MetaData +Status: Proposed +Authors: + - Steven Johnson +Implementors: [] +Discussions: + - https://github.com/cardano-foundation/cips/pulls/? +Created: 2023-10-24 +License: CC-BY-4.0 +--- + + + + +# Role Based Access Control Registration + +## Abstract + + +## Motivation: why is this CIP necessary? + + +## Specification + + +## Rationale: how does this CIP achieve its goals? + + +## Path to Active + +### Acceptance Criteria + + +### Implementation Plan + + +## Copyright + diff --git a/docs/src/catalyst-standards/draft-cips/role-registration/.meta.yml b/docs/src/catalyst-standards/draft-cips/role-registration/.meta.yml new file mode 100644 index 0000000000..409bc882c5 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/role-registration/.meta.yml @@ -0,0 +1 @@ +icon: material/account-edit diff --git a/docs/src/catalyst-standards/draft-cips/role-registration/cip-xxxx.md b/docs/src/catalyst-standards/draft-cips/role-registration/cip-xxxx.md new file mode 100644 index 0000000000..62dc189898 --- /dev/null +++ b/docs/src/catalyst-standards/draft-cips/role-registration/cip-xxxx.md @@ -0,0 +1,69 @@ +--- +CIP: /? +Title: Role based Access Control Registration +Category: MetaData +Status: Proposed +Authors: + - Steven Johnson +Implementors: [] +Discussions: + - https://github.com/cardano-foundation/cips/pulls/? +Created: 2023-10-24 +License: CC-BY-4.0 +--- + + + + +# Role Based Access Control Registration + +## Abstract + + +## Motivation: why is this CIP necessary? + + +## Specification + + +## Rationale: how does this CIP achieve its goals? + + +## Path to Active + +### Acceptance Criteria + + +### Implementation Plan + + +## Copyright + diff --git a/docs/src/catalyst-standards/index.md b/docs/src/catalyst-standards/index.md new file mode 100644 index 0000000000..8cd5a72972 --- /dev/null +++ b/docs/src/catalyst-standards/index.md @@ -0,0 +1,6 @@ +--- +icon: material/pillar +--- + + +# Catalyst Standards diff --git a/docs/src/getting-started/advanced.md b/docs/src/getting-started/advanced.md new file mode 100644 index 0000000000..0dbaa23aeb --- /dev/null +++ b/docs/src/getting-started/advanced.md @@ -0,0 +1,5 @@ +--- +icon: material/rotate-orbit +--- + +# Advanced diff --git a/docs/src/getting-started/development.md b/docs/src/getting-started/development.md new file mode 100644 index 0000000000..d5d27e1e6d --- /dev/null +++ b/docs/src/getting-started/development.md @@ -0,0 +1,5 @@ +--- +icon: material/hammer-wrench +--- + +# Development diff --git a/docs/src/getting-started/index.md b/docs/src/getting-started/index.md new file mode 100644 index 0000000000..66983499f7 --- /dev/null +++ b/docs/src/getting-started/index.md @@ -0,0 +1,5 @@ +--- +icon: material/flag-triangle +--- + +# Getting Started diff --git a/docs/src/getting-started/quick-start.md b/docs/src/getting-started/quick-start.md new file mode 100644 index 0000000000..a2ba6399c0 --- /dev/null +++ b/docs/src/getting-started/quick-start.md @@ -0,0 +1,5 @@ +--- +icon: material/horse-variant-fast +--- + +# Quick Start diff --git a/docs/src/important/coc.md b/docs/src/important/coc.md new file mode 100644 index 0000000000..60fbf695c6 --- /dev/null +++ b/docs/src/important/coc.md @@ -0,0 +1,5 @@ +--- +icon: material/file-sign +--- + +# Code of Conduct diff --git a/docs/src/important/contributing.md b/docs/src/important/contributing.md new file mode 100644 index 0000000000..9cb8036773 --- /dev/null +++ b/docs/src/important/contributing.md @@ -0,0 +1,5 @@ +--- +icon: material/pen-plus +--- + +# Contributing diff --git a/docs/src/important/index.md b/docs/src/important/index.md new file mode 100644 index 0000000000..df6e9085fb --- /dev/null +++ b/docs/src/important/index.md @@ -0,0 +1,5 @@ +--- +icon: material/alert-decagram-outline +--- + +# Important diff --git a/docs/src/important/license.md b/docs/src/important/license.md new file mode 100644 index 0000000000..f89f9e0ed6 --- /dev/null +++ b/docs/src/important/license.md @@ -0,0 +1,15 @@ +--- +icon: material/license +--- + +# License + + + +??? note "Apache 2 License" + + {{ include_file('..', 0, 4) }} + +??? note "MIT License" + + MIT diff --git a/docs/src/important/security.md b/docs/src/important/security.md new file mode 100644 index 0000000000..bb71804c82 --- /dev/null +++ b/docs/src/important/security.md @@ -0,0 +1,5 @@ +--- +icon: material/security +--- + +# Security diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000000..d6e791c23d --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,10 @@ +--- +icon: material/chat +--- + +# Project Catalyst - Catalyst Voices + +## How the docs are built + +* [MkDocs](https://www.mkdocs.org) +* [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) diff --git a/docs/src/monorepo-architecture/index.md b/docs/src/monorepo-architecture/index.md new file mode 100644 index 0000000000..00297fc9a2 --- /dev/null +++ b/docs/src/monorepo-architecture/index.md @@ -0,0 +1,6 @@ +--- +icon: material/pencil-ruler +--- + + +# Monorepo Architecture