Vishesh 'ironeagle' Bangotra
4b0fdfaf85
- Renamed `02_architecture.md` to `02_components.md` to match the standard component page naming convention.
- Updated `docs/mkdocs.wiki.yml` to reflect renamed pages and fix navigation label acronym casing (GSDFC, MCP, MkDocs).
- Updated `index.md` to include the mandatory doc model blockquote, standardize section headers with emojis, and accurately map the `Documentation Structure` table to the navigation menu.
- Standardized all wiki pages (`01_overview.md`, `02_components.md`, `03_conventions.md`, `04_iterative_workflow.md`, and `05_development/*`) by:
- Adding horizontal rules (`---`) between major sections.
- Applying emoji-prefixed H2 headings for recognizable section types.
- Appending `## Related` or `## ➡️ Read Next` footers with standard relative cross-links.
- Adjusting H1 headers to match guide anatomy (e.g., `# Library Overview` on the overview page).
30 lines
573 B
Markdown
30 lines
573 B
Markdown
# Environment Setup
|
||
|
||
---
|
||
|
||
## 🚀 Create the environment
|
||
|
||
```bash
|
||
python -m venv .venv
|
||
.venv\Scripts\activate
|
||
pip install -e .
|
||
```
|
||
|
||
Requires Python 3.10+ (per `pyproject.toml`).
|
||
|
||
---
|
||
|
||
## 📦 Dependencies
|
||
|
||
Development extras include:
|
||
|
||
- `pytest`, `pytest-cov` — test suite and coverage
|
||
- `ruff` — lint and format checking
|
||
- `black` — auto-formatting
|
||
- `mypy` — strict typing checks
|
||
- `pydoclint` — docstring ↔ signature consistency checks
|
||
|
||
---
|
||
|
||
## Related
|
||
- [04 – Iterative Workflow](../04_iterative_workflow.md) · [02 – Quality Gates](02_quality_gates.md) |