Skip to content

Commit 44c3d15

Browse files
CptPlasticCptPlastic
committed
Add legacy-styled docs homepage and mkdocs config
Replace the simple Markdown index with a rich, legacy HTML-styled homepage (docs/index.md) that includes cover, sections for spells/tomes/relics, command reference, install/usage examples, and links to the source and PyPI. Update mkdocs.yml to enable attr_list and md_in_html extensions and add extra_css/extra_javascript entries for assets/stylesheets/homebrew-legacy.css and assets/javascripts/homebrew-legacy.js so the new layout and scripts render correctly.
1 parent 0053998 commit 44c3d15

File tree

2 files changed

+131
-21
lines changed

2 files changed

+131
-21
lines changed

‎docs/index.md‎

Lines changed: 123 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,133 @@
1-
# Lore
1+
<div class="legacy-home">
2+
<canvas id="sparkles" aria-hidden="true"></canvas>
23

3-
Lore is a local memory system for software projects.
4+
<div class="page">
5+
<header class="cover">
6+
<div class="sigil">📜</div>
7+
<h1>Lore</h1>
8+
<p class="subtitle">Keeper of the Chronicle</p>
9+
<p class="tagline">The spellbook for your codebase: chronicle decisions, context, and lessons your AI companions can actually read.</p>
10+
</header>
411

5-
It captures decisions, facts, and lessons in plain files so your AI coding tools can use shared context across sessions.
12+
<section class="parchment">
13+
<h2><span class="rune">✦</span> What is Lore?</h2>
14+
<p>AI coding tools are stateless. They do not remember why you chose PostgreSQL over SQLite, which safety rules cannot be bypassed, or what tradeoffs already shaped this codebase.</p>
15+
<p><strong>Lore</strong> fixes that. It is a local AI memory system for software projects. You capture knowledge once as plain files alongside your code, then export it into instruction files your tools can read automatically.</p>
16+
<p>No external database. No API keys. No cloud sync. Everything lives in <code>.lore/</code> next to your repo.</p>
17+
<div class="badge-row">
18+
<span class="ver-badge">LOCAL YAML STORE</span>
19+
<span class="ver-badge">CHRONICLE FIRST</span>
20+
<span class="ver-badge">NO CLOUD SYNC</span>
21+
<span class="ver-badge">TOOL-AGNOSTIC</span>
22+
</div>
23+
</section>
624

7-
## Start Here
25+
<section class="parchment">
26+
<h2><span class="rune">⚜</span> The Three Artefacts</h2>
827

9-
- [Install](install.md)
10-
- [Core Concepts](concepts.md)
11-
- [CLI Reference](cli.md)
12-
- [FAQ](faq.md)
28+
<h3>Spell</h3>
29+
<p>A single piece of knowledge: a decision, a fact, a hard-won lesson, or a preference worth preserving.</p>
1330

14-
## How It Works
31+
<h3>Tome</h3>
32+
<p>A named collection of spells. Default tomes include <code>decisions</code>, <code>facts</code>, <code>preferences</code>, and <code>summaries</code>.</p>
1533

16-
1. Add memory entries with `lore add`.
17-
2. Search memory with `lore search`.
18-
3. Export context files with `lore export`.
34+
<h3>Relic</h3>
35+
<p>A raw artifact saved as-is for later distillation. Use relics when things are moving too fast to curate carefully in the moment.</p>
36+
</section>
1937

20-
## Quick Example
38+
<section class="parchment">
39+
<h2><span class="rune">✧</span> How the Magic Flows</h2>
40+
<div class="scroll-diagram">Your decisions, facts and lessons
41+
↓ lore add / lore relic
42+
.lore/ (plain YAML)
43+
↓ lore export
44+
CHRONICLE.md ← full project memory
45+
↓ referenced by lean adapters
46+
Copilot · Claude · Cursor · AGENTS · prompts
47+
↓
48+
Every AI tool reads your repo context</div>
49+
</section>
2150

22-
```bash
23-
lore onboard
24-
lore add decisions "Use PostgreSQL for row-level locking"
25-
lore search "why did we choose postgres"
26-
lore export
27-
```
51+
<section class="parchment">
52+
<h2><span class="rune">✶</span> First Invocation</h2>
53+
<p>Start with onboarding. Lore walks through store setup, your first memory entry, and export flow in one guided ritual.</p>
54+
<div class="incantation">lore onboard</div>
55+
<ol class="ritual-steps">
56+
<li><strong>Initialize the spellbook</strong> with a project description and local defaults.</li>
57+
<li><strong>Record real knowledge</strong> as decisions, facts, preferences, or summaries.</li>
58+
<li><strong>Export the chronicle</strong> so every supported AI tool inherits the same context.</li>
59+
<li><strong>Enable semantic search</strong> later with <code>lore setup semantic</code> if you want dense embeddings.</li>
60+
</ol>
61+
<div class="note">Requirements: Python 3.10+. Dense vector search is optional. Lore falls back to TF-IDF when needed.</div>
62+
</section>
2863

29-
## Notes
64+
<section class="parchment">
65+
<h2><span class="rune">⌘</span> Start Here</h2>
66+
<div class="target-list">
67+
<div class="target-item">
68+
<strong><a href="install.md">Install</a></strong>
69+
Setup instructions for PyPI, local development, and semantic search extras.
70+
</div>
71+
<div class="target-item">
72+
<strong><a href="concepts.md">Core Concepts</a></strong>
73+
Understand spells, tomes, relics, and the chronicle model.
74+
</div>
75+
<div class="target-item">
76+
<strong><a href="cli.md">CLI Reference</a></strong>
77+
Learn the primary commands for capture, search, and export.
78+
</div>
79+
<div class="target-item">
80+
<strong><a href="faq.md">FAQ</a></strong>
81+
Short answers to common questions about storage, AI tools, and workflow.
82+
</div>
83+
</div>
84+
</section>
3085

31-
If you are migrating existing docs, place markdown files in `docs/` and update navigation in `mkdocs.yml`.
86+
<section class="parchment">
87+
<h2><span class="rune">🜏</span> Incantations</h2>
88+
89+
<h3>Install via pip</h3>
90+
<div class="incantation">pip install lore-book</div>
91+
92+
<h3>Local development</h3>
93+
<div class="incantation">pip install -e .</div>
94+
95+
<h3>Cast your first spells</h3>
96+
<div class="incantation">lore add decisions "Use PostgreSQL for row-level locking"
97+
lore add facts "Auth service is the sole issuer of JWTs"
98+
lore export</div>
99+
</section>
100+
101+
<section class="parchment">
102+
<h2><span class="rune">📖</span> Grimoire of Commands</h2>
103+
<div class="command-columns">
104+
<div class="command-item">
105+
<strong>Store</strong>
106+
<p><code>lore onboard</code>, <code>lore init</code>, <code>lore add</code>, <code>lore list</code>, <code>lore remove</code></p>
107+
</div>
108+
<div class="command-item">
109+
<strong>Search</strong>
110+
<p><code>lore search &lt;query&gt;</code>, <code>lore index rebuild</code>, <code>lore setup semantic</code></p>
111+
</div>
112+
<div class="command-item">
113+
<strong>Relics</strong>
114+
<p><code>lore relic capture</code>, <code>lore relic list</code>, <code>lore relic view</code>, <code>lore relic distill</code></p>
115+
</div>
116+
<div class="command-item">
117+
<strong>Publishing</strong>
118+
<p><code>lore export</code>, <code>lore export --format prompt</code>, <code>lore config &lt;key&gt; &lt;value&gt;</code></p>
119+
</div>
120+
</div>
121+
<div class="links">
122+
<a class="link-rune" href="https://github.com/CptPlastic/lore-book">✦ Source Repository</a>
123+
<a class="link-rune" href="https://pypi.org/project/lore-book/">⚜ PyPI Package</a>
124+
</div>
125+
</section>
126+
127+
<div class="divider">— ✦ — ✦ — ✦ —</div>
128+
129+
<footer>
130+
LORE · CANONICAL DOCUMENTATION · FSL-1.1-MIT
131+
</footer>
132+
</div>
133+
</div>

‎mkdocs.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,17 @@ theme:
1313

1414
markdown_extensions:
1515
- admonition
16+
- attr_list
17+
- md_in_html
1618
- toc:
1719
permalink: true
1820

21+
extra_css:
22+
- assets/stylesheets/homebrew-legacy.css
23+
24+
extra_javascript:
25+
- assets/javascripts/homebrew-legacy.js
26+
1927
nav:
2028
- Home: index.md
2129
- Install: install.md

0 commit comments

Comments
 (0)