Skip to content

Commit f2979bd

Browse files
authored
refactor(docs): reorganize navigation in mkdocs.yml (#381)
- Moved "Anoma architecture" to the main navigation level and "Anomian" under the "Tutorials" section for improved clarity and accessibility. This change aims to streamline the documentation structure, making key sections easier to locate. - Fixes typo in hook ID and excludes .git/ files from filename validation
1 parent 117a661 commit f2979bd

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ repos:
6868
entry: python -c "import sys, re; sys.exit(1 if any(not re.match(r'^[a-z0-9_.-]+$', f.split('/')[-1]) for f in sys.argv[1:]) else 0)"
6969
language: python
7070
types: [file]
71-
exclude: '.pre-commit.*|^overrides.*|^docs/(assets|images)/|^formal.*|.*Package.juvix.*|^\.github/.*|CITATION|LICENSE|Makefile|README\.md|VERSION|.changelog/.*'
71+
exclude: '\.git/|\.pre-commit.*|^overrides.*|^docs/(assets|images)/|^formal.*|.*Package\.juvix.*|^\.github/.*|CITATION|LICENSE|Makefile|README\.md|VERSION|\.changelog/.*'
7272

7373
- id: typecheck
7474
name: typecheck

mkdocs.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,13 @@ edit_uri: edit/main/docs/
1111
use_directory_urls: false
1212
nav:
1313
- Home: index.md
14+
- Anoma architecture: ./arch/overview.md
1415
- Changelog: ./changelog.md
1516
- Indexes:
1617
- List of tags: ./indexes/tags.md
1718
- List of modules: ./indexes/modules.md
1819
- List of basic types: ./prelude.juvix.md
1920
# - List of engines: ./indexes/engines.md
20-
- Introduction:
21-
- Anomian: ./anomian.juvix.md
22-
- Anoma architecture: ./arch/overview.md
2321
- Node architecture:
2422
- Concepts:
2523
- Engine: ./arch/node/concepts/engine.md
@@ -230,6 +228,7 @@ nav:
230228
- ./arch/integrations/adapters/index.md
231229
- Ethereum Virtual Machine: ./arch/integrations/adapters/evm.md
232230
- Tutorials:
231+
- Anomian: ./anomian.juvix.md
233232
- Contributor guidelines:
234233
- Global principles and guidelines: ./tutorial/principles_and_guidelines.md
235234
- Prepare working environment: ./tutorial/install/index.md

0 commit comments

Comments
 (0)