From 14ed19d2d5e762cf54e1c587f33a5932726063f9 Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Sat, 21 Feb 2026 16:47:27 +0000 Subject: [PATCH] module as source doc fixes (#2) Reviewed-on: https://git.aetoskia.com/aetos/openapi-first/pulls/2 Co-authored-by: Vishesh 'ironeagle' Bangotra Co-committed-by: Vishesh 'ironeagle' Bangotra --- docforge.nav.yml | 12 ++++++------ docs/{openapi_first => }/app.md | 0 docs/{openapi_first => }/binder.md | 0 docs/{openapi_first => }/cli.md | 0 docs/{openapi_first => }/client.md | 0 docs/{openapi_first => }/errors.md | 0 docs/{openapi_first => }/index.md | 2 +- docs/{openapi_first => }/loader.md | 0 .../templates/crud_app/data.md | 0 .../templates/crud_app/index.md | 0 .../templates/crud_app/main.md | 0 .../templates/crud_app/routes.md | 0 .../templates/crud_app/test_crud_app.md | 0 .../templates/health_app/index.md | 0 .../templates/health_app/main.md | 0 .../templates/health_app/routes.md | 0 docs/{openapi_first => }/templates/index.md | 0 .../templates/model_app/data.md | 0 .../templates/model_app/index.md | 0 .../templates/model_app/main.md | 0 .../templates/model_app/models.md | 0 .../templates/model_app/routes.md | 0 .../templates/model_app/test_model_app.md | 0 mkdocs.yml | 17 +++++++---------- 24 files changed, 14 insertions(+), 17 deletions(-) rename docs/{openapi_first => }/app.md (100%) rename docs/{openapi_first => }/binder.md (100%) rename docs/{openapi_first => }/cli.md (100%) rename docs/{openapi_first => }/client.md (100%) rename docs/{openapi_first => }/errors.md (100%) rename docs/{openapi_first => }/index.md (54%) rename docs/{openapi_first => }/loader.md (100%) rename docs/{openapi_first => }/templates/crud_app/data.md (100%) rename docs/{openapi_first => }/templates/crud_app/index.md (100%) rename docs/{openapi_first => }/templates/crud_app/main.md (100%) rename docs/{openapi_first => }/templates/crud_app/routes.md (100%) rename docs/{openapi_first => }/templates/crud_app/test_crud_app.md (100%) rename docs/{openapi_first => }/templates/health_app/index.md (100%) rename docs/{openapi_first => }/templates/health_app/main.md (100%) rename docs/{openapi_first => }/templates/health_app/routes.md (100%) rename docs/{openapi_first => }/templates/index.md (100%) rename docs/{openapi_first => }/templates/model_app/data.md (100%) rename docs/{openapi_first => }/templates/model_app/index.md (100%) rename docs/{openapi_first => }/templates/model_app/main.md (100%) rename docs/{openapi_first => }/templates/model_app/models.md (100%) rename docs/{openapi_first => }/templates/model_app/routes.md (100%) rename docs/{openapi_first => }/templates/model_app/test_model_app.md (100%) diff --git a/docforge.nav.yml b/docforge.nav.yml index eaa250a..7cbd3ab 100644 --- a/docforge.nav.yml +++ b/docforge.nav.yml @@ -1,10 +1,10 @@ -home: openapi_first/index.md +home: index.md groups: Application Bootstrap: - - openapi_first/app.md - - openapi_first/binder.md + - app.md + - binder.md Core Utilities: - - openapi_first/loader.md - - openapi_first/errors.md + - loader.md + - errors.md OpenAPI Client: - - openapi_first/client.md + - client.md diff --git a/docs/openapi_first/app.md b/docs/app.md similarity index 100% rename from docs/openapi_first/app.md rename to docs/app.md diff --git a/docs/openapi_first/binder.md b/docs/binder.md similarity index 100% rename from docs/openapi_first/binder.md rename to docs/binder.md diff --git a/docs/openapi_first/cli.md b/docs/cli.md similarity index 100% rename from docs/openapi_first/cli.md rename to docs/cli.md diff --git a/docs/openapi_first/client.md b/docs/client.md similarity index 100% rename from docs/openapi_first/client.md rename to docs/client.md diff --git a/docs/openapi_first/errors.md b/docs/errors.md similarity index 100% rename from docs/openapi_first/errors.md rename to docs/errors.md diff --git a/docs/openapi_first/index.md b/docs/index.md similarity index 54% rename from docs/openapi_first/index.md rename to docs/index.md index 02dd173..ee4b379 100644 --- a/docs/openapi_first/index.md +++ b/docs/index.md @@ -1,3 +1,3 @@ -# Openapi First +# openapi_first ::: openapi_first diff --git a/docs/openapi_first/loader.md b/docs/loader.md similarity index 100% rename from docs/openapi_first/loader.md rename to docs/loader.md diff --git a/docs/openapi_first/templates/crud_app/data.md b/docs/templates/crud_app/data.md similarity index 100% rename from docs/openapi_first/templates/crud_app/data.md rename to docs/templates/crud_app/data.md diff --git a/docs/openapi_first/templates/crud_app/index.md b/docs/templates/crud_app/index.md similarity index 100% rename from docs/openapi_first/templates/crud_app/index.md rename to docs/templates/crud_app/index.md diff --git a/docs/openapi_first/templates/crud_app/main.md b/docs/templates/crud_app/main.md similarity index 100% rename from docs/openapi_first/templates/crud_app/main.md rename to docs/templates/crud_app/main.md diff --git a/docs/openapi_first/templates/crud_app/routes.md b/docs/templates/crud_app/routes.md similarity index 100% rename from docs/openapi_first/templates/crud_app/routes.md rename to docs/templates/crud_app/routes.md diff --git a/docs/openapi_first/templates/crud_app/test_crud_app.md b/docs/templates/crud_app/test_crud_app.md similarity index 100% rename from docs/openapi_first/templates/crud_app/test_crud_app.md rename to docs/templates/crud_app/test_crud_app.md diff --git a/docs/openapi_first/templates/health_app/index.md b/docs/templates/health_app/index.md similarity index 100% rename from docs/openapi_first/templates/health_app/index.md rename to docs/templates/health_app/index.md diff --git a/docs/openapi_first/templates/health_app/main.md b/docs/templates/health_app/main.md similarity index 100% rename from docs/openapi_first/templates/health_app/main.md rename to docs/templates/health_app/main.md diff --git a/docs/openapi_first/templates/health_app/routes.md b/docs/templates/health_app/routes.md similarity index 100% rename from docs/openapi_first/templates/health_app/routes.md rename to docs/templates/health_app/routes.md diff --git a/docs/openapi_first/templates/index.md b/docs/templates/index.md similarity index 100% rename from docs/openapi_first/templates/index.md rename to docs/templates/index.md diff --git a/docs/openapi_first/templates/model_app/data.md b/docs/templates/model_app/data.md similarity index 100% rename from docs/openapi_first/templates/model_app/data.md rename to docs/templates/model_app/data.md diff --git a/docs/openapi_first/templates/model_app/index.md b/docs/templates/model_app/index.md similarity index 100% rename from docs/openapi_first/templates/model_app/index.md rename to docs/templates/model_app/index.md diff --git a/docs/openapi_first/templates/model_app/main.md b/docs/templates/model_app/main.md similarity index 100% rename from docs/openapi_first/templates/model_app/main.md rename to docs/templates/model_app/main.md diff --git a/docs/openapi_first/templates/model_app/models.md b/docs/templates/model_app/models.md similarity index 100% rename from docs/openapi_first/templates/model_app/models.md rename to docs/templates/model_app/models.md diff --git a/docs/openapi_first/templates/model_app/routes.md b/docs/templates/model_app/routes.md similarity index 100% rename from docs/openapi_first/templates/model_app/routes.md rename to docs/templates/model_app/routes.md diff --git a/docs/openapi_first/templates/model_app/test_model_app.md b/docs/templates/model_app/test_model_app.md similarity index 100% rename from docs/openapi_first/templates/model_app/test_model_app.md rename to docs/templates/model_app/test_model_app.md diff --git a/mkdocs.yml b/mkdocs.yml index 9269196..4cba7a1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,3 @@ -site_name: Aetoskia OpenAPI First -site_description: Contract-first FastAPI application bootstrap and specification-driven HTTP client. - theme: name: material palette: @@ -34,14 +31,14 @@ plugins: annotations_path: brief show_root_heading: true group_by_category: true - +site_name: openapi_first nav: -- Home: openapi_first/index.md +- Home: index.md - Application Bootstrap: - - openapi_first/app.md - - openapi_first/binder.md + - app.md + - binder.md - Core Utilities: - - openapi_first/loader.md - - openapi_first/errors.md + - loader.md + - errors.md - OpenAPI Client: - - openapi_first/client.md + - client.md