Skip to content

Commit 3c4837b

Browse files
committed
docs: fix README repository structure and broken links
- Update Repository Structure section to match actual filesystem - Fix broken documentation link from templates/tofu/lxd/README.md to docs/tofu-lxd-configuration.md - Remove duplicate src/ entries and add missing directories - Fix character encoding issues in documentation links section - Add comprehensive directory structure with all packages, configs, and subdirectories
1 parent f22d88f commit 3c4837b

File tree

1 file changed

+62
-30
lines changed

1 file changed

+62
-30
lines changed

README.md

Lines changed: 62 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This repository uses LXD containers for virtualization:
2525
- **Best for**: CI/CD environments, fast provisioning, local development
2626
- **Requirements**: No special virtualization needed
2727

28-
**[📖 See detailed documentation →](templates/tofu/lxd/README.md)**
28+
**[📖 See detailed documentation →](docs/tofu-lxd-configuration.md)**
2929

3030
## � Provider Comparison
3131

@@ -229,46 +229,78 @@ The repository includes comprehensive GitHub Actions workflows for CI testing:
229229
## 📁 Repository Structure
230230

231231
```text
232-
├── src/ # Rust application source code
233-
│ ├── main.rs # Main application binary
234-
│ └── bin/
235-
│ └── e2e_tests.rs # E2E tests binary
236-
├── docs/ # Detailed documentation
237-
│ ├── tech-stack/ # Generic technology documentation
232+
├── .github/ # CI/CD workflows and GitHub configuration
233+
│ └── workflows/ # GitHub Actions workflow files
234+
├── .vscode/ # VS Code workspace configuration
235+
├── build/ # 📁 Generated runtime configs (git-ignored)
236+
│ ├── tofu/ # 🏗️ Runtime OpenTofu configs
237+
│ └── ansible/ # 🤖 Runtime Ansible configs
238+
├── data/ # Data files and templates
239+
│ └── templates/ # Template sources for generation
240+
│ ├── ansible/ # Ansible template sources
241+
│ └── tofu/ # OpenTofu template sources
242+
├── docs/ # 📖 Detailed documentation
243+
│ ├── tech-stack/ # Technology-specific documentation
238244
│ │ ├── opentofu.md # OpenTofu installation and usage
239245
│ │ ├── ansible.md # Ansible installation and usage
240246
│ │ └── lxd.md # LXD system containers
241247
│ ├── decisions/ # Architecture Decision Records (ADRs)
242-
│ │ └── meson-removal.md # Decision to remove Meson build system
243-
│ ├── documentation.md # Documentation organization guide
244-
│ └── vm-providers.md # Provider comparison for this project
248+
│ ├── contributing/ # Contributing guidelines and conventions
249+
│ │ ├── README.md # Main contributing guide
250+
│ │ ├── branching.md # Git branching conventions
251+
│ │ ├── commit-process.md # Commit process and pre-commit checks
252+
│ │ └── testing.md # Testing conventions
253+
│ ├── research/ # Research and analysis documents
254+
│ └── *.md # Various documentation files
255+
├── examples/ # Example configurations and usage
256+
├── fixtures/ # Test fixtures and sample data
257+
│ ├── testing_rsa* # SSH key pair for testing
258+
│ └── opentofu/ # OpenTofu test fixtures
259+
├── packages/ # Rust workspace packages
260+
│ └── linting/ # Linting utilities package
261+
│ └── src/ # Linting implementation source code
262+
├── scripts/ # Development and utility scripts
263+
│ └── setup/ # Installation scripts for dependencies
264+
├── src/ # 🦀 Main Rust application source code
265+
│ ├── main.rs # Main application binary entry point
266+
│ ├── lib.rs # Library root module
267+
│ ├── bin/ # Binary executables
268+
│ │ ├── linter.rs # Unified linting command interface
269+
│ │ └── e2e_tests.rs # End-to-end testing binary
270+
│ ├── ansible/ # Ansible integration modules
271+
│ ├── command_wrappers/ # External command wrapper modules
272+
│ ├── commands/ # CLI command implementations
273+
│ ├── config/ # Configuration handling
274+
│ ├── e2e/ # End-to-end testing infrastructure
275+
│ ├── remote_actions/ # Remote system management actions
276+
│ ├── steps/ # Deployment step implementations
277+
│ ├── template/ # Template processing and rendering
278+
│ └── tofu/ # OpenTofu integration modules
245279
├── templates/ # 📁 Template configurations (git-tracked)
246-
│ ├── tofu/ # 🏗️ OpenTofu/Terraform templates
247-
│ │ └── lxd/ # LXD container template configuration
248-
│ └── ansible/ # 🤖 Ansible playbook templates
249-
├── build/ # 📁 Generated runtime configs (git-ignored)
250-
│ ├── tofu/ # 🏗️ Runtime OpenTofu configs
251-
│ └── ansible/ # 🤖 Runtime Ansible configs
252-
├── scripts/ # Development and utility scripts
253-
│ └── setup/ # Setup scripts for dependencies
254-
├── src/ # Rust source code
255-
│ ├── bin/ # Binary executables
256-
│ │ ├── linter.rs # Unified linting command interface
257-
│ │ └── e2e_tests.rs # End-to-end testing binary
258-
│ └── linting/ # Linting module and implementations
259-
├── .github/workflows/ # CI/CD workflows
260-
├── Cargo.toml # Rust project configuration
261-
├── README.md # This file - project overview
262-
├── target/ # Rust build artifacts (ignored)
263-
└── .gitignore # Git ignore rules
280+
│ ├── tofu/ # 🏗️ OpenTofu/Terraform templates
281+
│ │ └── lxd/ # LXD container template configuration
282+
│ └── ansible/ # 🤖 Ansible playbook templates
283+
├── tests/ # Integration and system tests
284+
├── target/ # 🦀 Rust build artifacts (git-ignored)
285+
├── Cargo.toml # Rust workspace configuration
286+
├── Cargo.lock # Rust dependency lock file
287+
├── main.tf # Root OpenTofu configuration
288+
├── cspell.json # Spell checking configuration
289+
├── project-words.txt # Custom dictionary for spell checking
290+
├── .markdownlint.json # Markdown linting configuration
291+
├── .taplo.toml # TOML formatting configuration
292+
├── .yamllint-ci.yml # YAML linting configuration for CI
293+
├── README.md # This file - project overview
294+
├── LICENSE # Project license
295+
└── .gitignore # Git ignore rules
264296
```
265297

266298
## 📚 Documentation
267299

268300
- **[🤝 Contributing Guide](docs/contributing/README.md)** - Git workflow, commit process, and linting conventions
269301
- **[📖 Documentation Organization Guide](docs/documentation.md)** - How documentation is organized and where to contribute
270-
- **[ Structured Logging Implementation Plan](docs/structured-logging-implementation-plan.md)** - Implementation plan for hierarchical logging with tracing spans
271-
- **[📖 OpenTofu Setup Guide](docs/tech-stack/opentofu.md)** - Installation, common commands, and best practices
302+
- **[📋 Structured Logging Implementation Plan](docs/structured-logging-implementation-plan.md)** - Implementation plan for hierarchical logging with tracing spans
303+
- **[📖 OpenTofu Setup Guide](docs/tech-stack/opentofu.md)** - Installation, common commands, and best practices
272304
- **[📖 Ansible Setup Guide](docs/tech-stack/ansible.md)** - Installation, configuration, and project usage
273305
- **[📖 VM Providers Comparison](docs/vm-providers.md)** - Detailed comparison and decision rationale
274306

0 commit comments

Comments
 (0)