Skip to content

Commit 4006772

Browse files
docs: reorganize documentation structure and update links for clarity
1 parent e41ac4c commit 4006772

41 files changed

Lines changed: 136 additions & 136 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/404.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ It may have been moved, renamed, or deleted.
1212
## Find What You Need
1313

1414
- [Get Started](index.md) — overview and quick example
15-
- [Installation](installation.md) — install ArchiPy and optional extras
15+
- [Installation](getting-started/installation.md) — install ArchiPy and optional extras
1616
- [Quickstart](getting-started/quickstart.md) — five-minute step-by-step guide
1717
- [Concepts](getting-started/concepts.md) — Clean Architecture layers and import rules
18-
- [Tutorials](examples/index.md) — guides for every adapter and helper
18+
- [Tutorials](tutorials/index.md) — guides for every adapter and helper
1919
- [API Reference](api_reference/index.md) — full reference for all public classes
20-
- [FAQ](faq.md) — frequently asked questions
20+
- [FAQ](community/faq.md) — frequently asked questions
2121

2222
!!! tip "Search the docs"
2323
Use the search bar at the top of the page to find any topic instantly.

docs/api_reference/configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ members_order: alphabetical
5252

5353
## Config Templates {#config-templates}
5454

55-
For practical examples, see the [Configuration Management Guide](../examples/config_management.md).
55+
For practical examples, see the [Configuration Management Guide](../tutorials/config_management.md).
5656

5757
### Database Configs
5858

docs/api_reference/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,12 @@ ArchiPy follows semantic versioning and marks API stability as follows:
9999
- 🟡 **Beta**: APIs that are stabilizing but may have breaking changes
100100
- 🔴 **Alpha**: Experimental APIs that may change significantly
101101

102-
See the [Changelog](../changelog.md) for version history and breaking changes.
102+
See the [Changelog](../community/changelog.md) for version history and breaking changes.
103103

104104
## Contributing
105105

106106
For information about contributing to ArchiPy's development, please see:
107107

108-
- [Contributing Guide](../contributing.md)
109-
- [Development Guide](../contributing.md)
108+
- [Contributing Guide](../community/contributing.md)
109+
- [Development Guide](../community/contributing.md)
110110
- [Documentation Guide](../contributing-docs.md)
File renamed without changes.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ New adapters follow a consistent checklist. Use this as your guide when contribu
224224
real-service scenarios.
225225

226226
7. **Document the adapter** — create both:
227-
- `docs/examples/adapters/<name>.md` — example guide (5 required sections)
227+
- `docs/tutorials/adapters/<name>.md` — example guide (5 required sections)
228228
- `docs/api_reference/adapters/<name>.md` — API reference with mkdocstrings
229229

230230
8. **Update `mkdocs.yml`** — add both new pages under the appropriate `nav:` keys.
@@ -251,7 +251,7 @@ This section outlines the standards and practices for ArchiPy documentation.
251251
- `docs/` - Markdown documentation files
252252
- `index.md` - Get Started page
253253
- `api_reference/` - API documentation
254-
- `examples/` - Usage examples
254+
- `tutorials/` - Usage examples
255255
- `assets/` - Images and other static assets
256256

257257
### Format and Style

docs/faq.md renamed to docs/community/faq.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ uv add "archipy[redis]"
128128
uv add "archipy[postgres,sqlalchemy]"
129129
```
130130

131-
See the [Installation](installation.md) page for the full extras table.
131+
See the [Installation](../getting-started/installation.md) page for the full extras table.
132132

133133
### What is the `mocks.py` file in adapters?
134134

@@ -160,7 +160,7 @@ uv add "archipy[fakeredis]" # in-memory Redis for tests
160160
uv add "archipy[testcontainers]" # Docker-backed real DBs for integration tests
161161
```
162162

163-
See the [Testing Strategy](examples/testing_strategy.md) guide for full patterns.
163+
See the [Testing Strategy](../tutorials/testing_strategy.md) guide for full patterns.
164164

165165
### How do I run BDD tests?
166166

@@ -174,7 +174,7 @@ Or target a single feature file:
174174
uv run behave features/my_feature.feature
175175
```
176176

177-
See the [BDD Testing](examples/testing_strategy.md) guide for Gherkin syntax and step definitions.
177+
See the [BDD Testing](../tutorials/testing_strategy.md) guide for Gherkin syntax and step definitions.
178178

179179
### What is the difference between unit tests and integration tests in ArchiPy?
180180

@@ -253,7 +253,7 @@ class AppConfig(BaseConfig):
253253
| `@timing` | `helpers.decorators.timing` | Execution time logging |
254254
| `@deprecated` | `helpers.decorators.deprecation_warnings` | Deprecation warning |
255255

256-
See the [Decorators tutorial](examples/helpers/decorators.md) for examples.
256+
See the [Decorators tutorial](../tutorials/helpers/decorators.md) for examples.
257257

258258
### What is the difference between `@singleton` decorator and `SingletonMeta` metaclass?
259259

@@ -267,8 +267,8 @@ Both enforce the singleton pattern but suit different use cases:
267267

268268
## See Also
269269

270-
- [Concepts](getting-started/concepts.md) — Clean Architecture layers and import rules
271-
- [Installation](installation.md) — optional extras and prerequisites
272-
- [Testing Strategy](examples/testing_strategy.md) — unit, integration, and BDD test patterns
273-
- [Configuration Management](examples/config_management.md) — environment variables, `.env` files, nested config
274-
- [Error Handling](examples/error_handling.md) — domain exceptions and chaining
270+
- [Concepts](../getting-started/concepts.md) — Clean Architecture layers and import rules
271+
- [Installation](../getting-started/installation.md) — optional extras and prerequisites
272+
- [Testing Strategy](../tutorials/testing_strategy.md) — unit, integration, and BDD test patterns
273+
- [Configuration Management](../tutorials/config_management.md) — environment variables, `.env` files, nested config
274+
- [Error Handling](../tutorials/error_handling.md) — domain exceptions and chaining
File renamed without changes.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ is_valid = PasswordUtils.verify_password(plain_password, hashed)
145145

146146
## See Also
147147

148-
- [Configuration Management](examples/config_management.md) — environment variables and secrets management
149-
- [JWT Utilities](examples/helpers/utils.md) — encoding and decoding JSON Web Tokens
150-
- [Installation](installation.md) — optional extras and dependencies
148+
- [Configuration Management](../tutorials/config_management.md) — environment variables and secrets management
149+
- [JWT Utilities](../tutorials/helpers/utils.md) — encoding and decoding JSON Web Tokens
150+
- [Installation](../getting-started/installation.md) — optional extras and dependencies
151151
- [Contributing](contributing.md) — responsible disclosure and code review process

docs/getting-started/complete_user_example.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -726,7 +726,7 @@ python manage.py run --port 9000 --reload
726726

727727
- [Concepts](concepts.md) — four-layer architecture and import rules
728728
- [Project Structure](project_structure.md) — reference folder layout
729-
- [Dependency Injection](../examples/dependency_injection.md) — DI container patterns in depth
730-
- [Configuration Management](../examples/config_management.md) — environment variables and `.env` files
731-
- [Error Handling](../examples/error_handling.md) — custom errors and HTTP mapping
732-
- [Testing Strategy](../examples/testing_strategy.md) — BDD testing with mock adapters
729+
- [Dependency Injection](../tutorials/dependency_injection.md) — DI container patterns in depth
730+
- [Configuration Management](../tutorials/config_management.md) — environment variables and `.env` files
731+
- [Error Handling](../tutorials/error_handling.md) — custom errors and HTTP mapping
732+
- [Testing Strategy](../tutorials/testing_strategy.md) — BDD testing with mock adapters

0 commit comments

Comments
 (0)