Skip to content

Commit 232c1ec

Browse files
docs: restructure and expand documentation with new guides and pages
- Add getting-started section (quickstart, concepts, project structure, complete user example) - Add new pages: FAQ, security, 404, CODE_OF_CONDUCT - Add examples: dependency injection, observability, testing strategy - Remove deprecated concepts.md and bdd_testing.md - Update adapter examples, contributing guide, and index page - Update mkdocs.yml navigation to reflect new structure
1 parent 481d04a commit 232c1ec

32 files changed

+3398
-1332
lines changed

docs/404.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Page Not Found
3+
description: The requested page could not be found. Navigate to the ArchiPy documentation home.
4+
---
5+
6+
# Page Not Found
7+
8+
The page you were looking for does not exist.
9+
10+
It may have been moved, renamed, or deleted.
11+
12+
## Find What You Need
13+
14+
- [Get Started](index.md) — overview and quick example
15+
- [Installation](installation.md) — install ArchiPy and optional extras
16+
- [Quickstart](getting-started/quickstart.md) — five-minute step-by-step guide
17+
- [Concepts](getting-started/concepts.md) — Clean Architecture layers and import rules
18+
- [Tutorials](examples/index.md) — guides for every adapter and helper
19+
- [API Reference](api_reference/index.md) — full reference for all public classes
20+
- [FAQ](faq.md) — frequently asked questions
21+
22+
!!! tip "Search the docs"
23+
Use the search bar at the top of the page to find any topic instantly.

docs/CODE_OF_CONDUCT.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Code of Conduct
3+
description: ArchiPy community standards for respectful and inclusive collaboration.
4+
---
5+
6+
# Code of Conduct
7+
8+
## Our Pledge
9+
10+
We as members, contributors, and leaders pledge to make participation in the ArchiPy community a harassment-free
11+
experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex
12+
characteristics, gender identity and expression, level of experience, education, socioeconomic status,
13+
nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
14+
15+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy
16+
community.
17+
18+
## Our Standards
19+
20+
**Examples of behaviour that contributes to a positive environment:**
21+
22+
- Demonstrating empathy and kindness toward other people
23+
- Being respectful of differing opinions, viewpoints, and experiences
24+
- Giving and gracefully accepting constructive feedback
25+
- Accepting responsibility and apologising to those affected by our mistakes
26+
- Focusing on what is best not just for us as individuals, but for the overall community
27+
28+
**Examples of unacceptable behaviour:**
29+
30+
- The use of sexualised language or imagery, and sexual attention or advances of any kind
31+
- Trolling, insulting or derogatory comments, and personal or political attacks
32+
- Public or private harassment
33+
- Publishing others' private information without explicit permission
34+
- Other conduct which could reasonably be considered inappropriate in a professional setting
35+
36+
## Enforcement Responsibilities
37+
38+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behaviour
39+
and will take appropriate and fair corrective action in response to any behaviour that they deem
40+
inappropriate, threatening, offensive, or harmful.
41+
42+
## Scope
43+
44+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially
45+
representing the community in public spaces.
46+
47+
## Enforcement
48+
49+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders
50+
via the [GitHub repository](https://github.com/SyntaxArc/ArchiPy). All complaints will be reviewed and
51+
investigated promptly and fairly.
52+
53+
## Attribution
54+
55+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
56+
version 2.1, available at
57+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
58+
59+
## See Also
60+
61+
- [Contributing](contributing.md) — how to contribute code, docs, and bug reports

0 commit comments

Comments
 (0)