Skip to content

Commit 158ac8a

Browse files
refactor: migrate Markdown to AsciiDoc (#40)
Automated migration of .md to .adoc per global rules, preserving wikis and critical exceptions.
1 parent 5735893 commit 158ac8a

59 files changed

Lines changed: 5763 additions & 5373 deletions

Some content is hidden

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

‎ARCHITECTURE.adoc‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
== Architecture
2+
3+
=== Overview
4+
5+
This repository follows a modular, maintainable architecture designed
6+
for clarity, scalability, and long-term sustainability.
7+
8+
=== Directory Structure
9+
10+
....
11+
.
12+
├── src/ # Source code
13+
├── tests/ # Test suites
14+
├── docs/ # Documentation
15+
├── scripts/ # Utility scripts
16+
├── config/ # Configuration files
17+
├── LICENSE # License file
18+
├── LICENSES/ # Full license texts
19+
└── README.adoc # Project documentation
20+
....
21+
22+
=== Design Principles
23+
24+
* *Separation of Concerns*: Each module has a single responsibility
25+
* *Testability*: Code is written to be easily testable
26+
* *Documentation*: All public APIs are documented
27+
* *Configuration*: Environment-specific settings are externalized
28+
29+
=== Dependencies
30+
31+
* External dependencies are minimized and clearly declared
32+
* Version pinning is used for reproducibility
33+
34+
=== Security Considerations
35+
36+
* Sensitive data is never committed to the repository
37+
* Secrets are managed through environment variables or secure vaults
38+
* Regular dependency audits are performed
39+
40+
=== Maintainability
41+
42+
* Code follows consistent style guidelines
43+
* Pull requests require review and CI checks
44+
* Issues and discussions are tracked transparently
45+
46+
'''''
47+
48+
_Last updated: 2026-07-18_

‎ARCHITECTURE.md‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎CHANGELOG.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
== Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on https://keepachangelog.com/en/1.1.0/[Keep a
6+
Changelog], and this project adheres to
7+
https://semver.org/spec/v2.0.0.html[Semantic Versioning].
8+
9+
=== [Unreleased]

‎CHANGELOG.md‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)