Skip to content

Commit 19bdb74

Browse files
committed
Regenerate docs
1 parent 2102753 commit 19bdb74

File tree

128 files changed

+7856
-72931
lines changed

Some content is hidden

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

128 files changed

+7856
-72931
lines changed

404.html

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

TU_Logo_black.svg

Lines changed: 97 additions & 0 deletions
Loading

about.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# About FineCode
2+
3+
## History
4+
5+
FineCode was started as part of a research project at [Technische Universität Wien](https://www.tuwien.at/) and is further developed by its author and contributors.
6+
7+
![TU Wien](TU_Logo_black.svg){ width=200 }
8+
9+
## Credits
10+
11+
Logo designed by [Yurii Fabirovskyi](https://fabirovskyi.site/).

adr/0001-use-adr.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# ADR-0001: Use ADRs for architecture decisions
2+
3+
- **Status:** accepted
4+
- **Date:** 2026-03-19
5+
- **Deciders:** @Aksem
6+
- **Tags:** meta
7+
8+
## Context
9+
10+
FineCode has several important architectural decisions that
11+
are currently documented implicitly across code, comments, and CLAUDE.md. When
12+
new contributors or AI agents work on the codebase, they lack visibility into
13+
*why* decisions were made, what alternatives were considered, and what
14+
constraints must be preserved.
15+
16+
As the project grows and automated testing is introduced, we need a lightweight
17+
way to record decisions so they can be referenced, reviewed, and superseded
18+
over time.
19+
20+
## Related ADRs Considered
21+
22+
None — this is the first ADR.
23+
24+
## Decision
25+
26+
We will use Architecture Decision Records stored in `docs/adr/` following a
27+
simplified [MADR](https://adr.github.io/madr/) (Markdown Any Decision Records)
28+
template. The required sections are Context, Related ADRs Considered, Decision,
29+
and Consequences. Each ADR is a sequentially numbered Markdown file.
30+
31+
The template also documents optional sections (Alternatives Considered, Risks,
32+
Related Decisions, References, Implementation Notes, Review Date) that can be
33+
added when they provide value, but are not required.
34+
35+
ADRs are immutable once accepted. Changed decisions produce a new ADR that
36+
supersedes the previous one.
37+
38+
## Consequences
39+
40+
- Every architecturally significant decision gets a permanent, discoverable
41+
record with its rationale.
42+
- New contributors and AI agents can understand *why* the codebase is shaped
43+
the way it is.
44+
- Slightly more process overhead per decision — mitigated by keeping the
45+
template minimal.
46+
- Existing implicit decisions can be backfilled as ADRs when they become
47+
relevant.

0 commit comments

Comments
 (0)