177 lines
6.9 KiB
HTML
177 lines
6.9 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title>Session Summary — 4 July 2026</title>
|
||
<link rel="stylesheet" href="../../../../_assets_/styles.css">
|
||
<link rel="stylesheet" href="../../../../_assets_/nav.css">
|
||
</head>
|
||
<body>
|
||
<div class="page">
|
||
|
||
<header>
|
||
<p class="date">Saturday, 4 July 2026 — Sunday, 5 July 2026</p>
|
||
<h1>Roject — Developer Documentation</h1>
|
||
<p class="subtitle">Session summary: doc/ folder restructure, project outline, coding guidelines, history index, CLAUDE.md cleanup.</p>
|
||
</header>
|
||
|
||
<section>
|
||
<h2>What we built</h2>
|
||
|
||
<div class="card">
|
||
<h3>Folder Restructure</h3>
|
||
<p>
|
||
The <code>history/</code> folder moved to <code>doc/history/</code> and
|
||
<code>history/styles.css</code> moved to <code>doc/_assets_/styles.css</code>
|
||
to serve as a shared stylesheet for all documentation. All existing history
|
||
entry CSS paths were updated accordingly. The new <code>doc/</code> root is
|
||
the single home for all project documentation going forward.
|
||
</p>
|
||
<div class="tags">
|
||
<span class="tag">doc/</span>
|
||
<span class="tag">doc/_assets_/styles.css</span>
|
||
<span class="tag">doc/history/</span>
|
||
<span class="tag">doc/outline/</span>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="card">
|
||
<h3>Project Documentation Outline</h3>
|
||
<p>
|
||
Created <code>doc/outline/index.html</code> — the main developer reference,
|
||
readable by both humans and agent contributors. It contains three sections:
|
||
a project outline (what Roject is, current state, loose todos), a technical
|
||
implementation overview (backend, frontend, shared library with tags), and
|
||
an actions section that defines repeatable tasks for Update History and
|
||
Update Documentation.
|
||
</p>
|
||
<div class="tags">
|
||
<span class="tag">doc/outline/index.html</span>
|
||
<span class="tag">project outline</span>
|
||
<span class="tag">tech stack</span>
|
||
<span class="tag">actions</span>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="card">
|
||
<h3>Coding Guidelines</h3>
|
||
<p>
|
||
Created <code>doc/outline/coding-guidelines/index.html</code> based on the
|
||
rokojori action library guidelines. Covers formatting (brackets on new line,
|
||
2-space soft tabs, spacing around operators), naming (camelCase, uppercase
|
||
for class names and statics, underscore prefix for internal members), and
|
||
design rules (static factory methods, early return, extract to named
|
||
functions, if/else over switch, initialise all members). Includes a
|
||
TypeScript example. C# and PHP examples were omitted.
|
||
</p>
|
||
<div class="tags">
|
||
<span class="tag">doc/outline/coding-guidelines/</span>
|
||
<span class="tag">TypeScript example</span>
|
||
<span class="tag">formatting</span>
|
||
<span class="tag">naming</span>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="card">
|
||
<h3>History Index</h3>
|
||
<p>
|
||
Created <code>doc/history/index.html</code> — a chronological list of all
|
||
session entries, most recent first, each with a one-line summary and a link
|
||
to the full entry. This file is updated by the Update History action at the
|
||
end of every session.
|
||
</p>
|
||
<div class="tags">
|
||
<span class="tag">doc/history/index.html</span>
|
||
<span class="tag">session index</span>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="card">
|
||
<h3>Stylesheet Extensions</h3>
|
||
<p>
|
||
Added <code>a</code>, <code>code</code>, <code>pre</code>, and
|
||
<code>pre code</code> styles to <code>doc/_assets_/styles.css</code> to
|
||
support the coding guidelines page. Inline code gets the accent colour on a
|
||
dark tag background; code blocks get a darker background with monospace font
|
||
and horizontal scrolling.
|
||
</p>
|
||
<div class="tags">
|
||
<span class="tag">pre</span>
|
||
<span class="tag">code</span>
|
||
<span class="tag">doc/_assets_/styles.css</span>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="card">
|
||
<h3>CLAUDE.md</h3>
|
||
<p>
|
||
Stripped <code>CLAUDE.md</code> down to a single line pointing to
|
||
<code>doc/outline/index.html</code>. All content that was in CLAUDE.md
|
||
(tech stack, conventions, IDs, TypeScript setup, commands, project structure)
|
||
is now in the outline with more detail.
|
||
</p>
|
||
<div class="tags">
|
||
<span class="tag">CLAUDE.md</span>
|
||
<span class="tag">pointer only</span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section>
|
||
<h2>Key Decisions</h2>
|
||
|
||
<div class="decision">
|
||
<strong>Documentation lives in <code>doc/</code>, not project root</strong>
|
||
<p>
|
||
Keeping all documentation under a single <code>doc/</code> directory makes the
|
||
root cleaner and gives history and outline a shared home without polluting the
|
||
server or source directories.
|
||
</p>
|
||
</div>
|
||
|
||
<div class="decision">
|
||
<strong>Todos are a loose reminder, not a backlog</strong>
|
||
<p>
|
||
The "what still needs work" card in the outline is intentionally written as
|
||
prose, not a checklist. It is updated on the go as features are added rather
|
||
than maintained as a formal task tracker.
|
||
</p>
|
||
</div>
|
||
|
||
<div class="decision">
|
||
<strong>Actions are written for agents and humans alike</strong>
|
||
<p>
|
||
The actions section in the outline describes repeatable tasks (Update History,
|
||
Update Documentation) with enough detail that an agent can execute them
|
||
correctly without asking follow-up questions: which file to create, what CSS
|
||
path to use, what to update after.
|
||
</p>
|
||
</div>
|
||
</section>
|
||
|
||
<section>
|
||
<h2>Project Structure</h2>
|
||
<div class="card">
|
||
<p>
|
||
<code>doc/_assets_/styles.css</code> — shared stylesheet for all doc pages<br>
|
||
<code>doc/outline/index.html</code> — main developer documentation<br>
|
||
<code>doc/outline/coding-guidelines/index.html</code> — formatting and naming rules<br>
|
||
<code>doc/history/index.html</code> — session history index<br>
|
||
<code>doc/history/YYYY/MM-Month/DD-Day/index.html</code> — individual session entries<br>
|
||
<code>CLAUDE.md</code> — one-line pointer to <code>doc/outline/index.html</code>
|
||
</p>
|
||
</div>
|
||
</section>
|
||
|
||
<footer>
|
||
Roject — session log — 4–5 July 2026
|
||
</footer>
|
||
|
||
</div>
|
||
<script>var NAV_ROOT = '../../../../';</script>
|
||
<script src="../../../../_assets_/nav-data.js"></script>
|
||
<script src="../../../../_assets_/nav.js"></script>
|
||
</body>
|
||
</html>
|