2026-07-06 17:28:59 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<title>Guides — Roject</title>
|
|
|
|
|
<link rel="stylesheet" href="../_assets_/styles.css">
|
|
|
|
|
<link rel="stylesheet" href="../_assets_/nav.css">
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div class="page">
|
|
|
|
|
|
|
|
|
|
<header>
|
|
|
|
|
<h1>Guides</h1>
|
|
|
|
|
<p class="subtitle">Reference guides for working in this project. Read the relevant guide before starting a task in that area.</p>
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
|
|
|
|
|
<div class="card">
|
|
|
|
|
<h3>Writing TypeScript Code</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Formatting rules, naming conventions, design patterns, and architectural
|
|
|
|
|
principles for all TypeScript in this project. Read this before writing
|
|
|
|
|
any application code.
|
|
|
|
|
</p>
|
|
|
|
|
<p style="margin-top:0.75rem">
|
|
|
|
|
<a href="writing-typescript-code/index.html">Read the guide</a>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2026-07-11 12:24:17 +00:00
|
|
|
<div class="card">
|
|
|
|
|
<h3>Writing Editor Panels</h3>
|
|
|
|
|
<p>
|
|
|
|
|
How to create a new panel for the editor: component files, toolbar
|
|
|
|
|
requirement, <code>connectedCallback</code> initialisation, duplicate
|
|
|
|
|
support, registration in the tab container menu, and responsive layout rules.
|
|
|
|
|
</p>
|
|
|
|
|
<p style="margin-top:0.75rem">
|
|
|
|
|
<a href="writing-editor-panels/index.html">Read the guide</a>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="card">
|
|
|
|
|
<h3>Writing Backend Routes</h3>
|
|
|
|
|
<p>
|
|
|
|
|
How to add a new API endpoint to the Express server: router file layout,
|
|
|
|
|
auth middleware, reading request data, JSON file storage, streaming responses,
|
|
|
|
|
and mounting in <code>server/index.ts</code>.
|
|
|
|
|
</p>
|
|
|
|
|
<p style="margin-top:0.75rem">
|
|
|
|
|
<a href="writing-backend-routes/index.html">Read the guide</a>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2026-07-06 17:28:59 +00:00
|
|
|
<div class="card">
|
|
|
|
|
<h3>Locales</h3>
|
|
|
|
|
<p>
|
|
|
|
|
How user-visible strings are stored as files, auto-generated into typed
|
|
|
|
|
TypeScript constants, and fetched at runtime via <code>LocaleManager</code>.
|
|
|
|
|
Read this before adding or changing any user-visible text.
|
|
|
|
|
</p>
|
|
|
|
|
<p style="margin-top:0.75rem">
|
|
|
|
|
<a href="locales/index.html">Read the guide</a>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2026-07-13 19:56:25 +00:00
|
|
|
<div class="card">
|
|
|
|
|
<h3>Agent Memory</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Where agents should store and recall project knowledge — the rule that the
|
|
|
|
|
workspace is the memory, what goes in the outline vs. history vs. guides,
|
|
|
|
|
and what (little) may go in Claude local memory files.
|
|
|
|
|
</p>
|
|
|
|
|
<p style="margin-top:0.75rem">
|
|
|
|
|
<a href="agent-memory/index.html">Read the guide</a>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2026-07-06 17:28:59 +00:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<footer>
|
|
|
|
|
Roject — guides
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<script>var NAV_ROOT = '../';</script>
|
|
|
|
|
<script src="../_assets_/nav-data.js"></script>
|
|
|
|
|
<script src="../_assets_/nav.js"></script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
