Skip to content

Commit cd6581a

Browse files
authored
chore(docs): Council-driven redesign: light, restrained, professional (#3)
1 parent 473ace5 commit cd6581a

31 files changed

Lines changed: 826 additions & 4841 deletions

.github/workflows/deploy.yml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Deploy
22

3+
# Build-only strict MkDocs build so a broken vendored page or nav entry
4+
# fails CI instead of deploying. See scripts/vendor-docs.sh and rac-core's
5+
# ADR-101 for the vendoring contract.
6+
37
on:
48
push:
59
branches: [main]
@@ -19,15 +23,18 @@ jobs:
1923
runs-on: ubuntu-latest
2024
steps:
2125
- uses: actions/checkout@v4
22-
- uses: actions/setup-node@v4
26+
- uses: actions/setup-python@v5
2327
with:
24-
node-version: 22
25-
cache: npm
26-
- run: npm ci
27-
- run: npm run build
28+
python-version: "3.12"
29+
- name: Install MkDocs
30+
run: pip install mkdocs==1.6.1 mkdocs-material==9.7.6
31+
- name: Vendor product docs
32+
run: ./scripts/vendor-docs.sh
33+
- name: Build site (strict)
34+
run: mkdocs build --strict
2835
- uses: actions/upload-pages-artifact@v3
2936
with:
30-
path: dist
37+
path: site
3138

3239
deploy:
3340
needs: build

.gitignore

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
node_modules/
2-
dist/
3-
.astro/
1+
site/
42

5-
# Build-time vendored content (see ADR-101 — never committed).
3+
# Build-time vendored content (see rac-core's ADR-101 — never committed).
64
.vendor/
7-
src/content/rac-core/*
8-
!src/content/rac-core/.gitkeep
5+
docs/rac-core/*
6+
!docs/rac-core/.gitkeep

README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,42 @@
11
# itsthelore.github.io
22

33
The `itsthelore` org's documentation site, served at
4-
https://itsthelore.github.io/. Built with [Astro](https://astro.build) and
5-
deployed by GitHub Actions on every push to `main`.
4+
https://itsthelore.github.io/. Built with [MkDocs](https://www.mkdocs.org)
5+
(Material theme) — the same tool and theme `rac-core` already uses for its
6+
own docs, so the org site and every product's docs read as one brand.
7+
Deployed by GitHub Actions on every push to `main`.
68

79
## How content gets here
810

911
Sections under `/rac-core/` (and future product sections) are **vendored,
10-
not authored here**: `npm run build` runs `scripts/vendor-docs.mjs` first,
11-
which sparse-checks out each source repo's `docs/` directory (see
12-
`vendor.config.json`) into `src/content/<slug>/` before the Astro build.
13-
Nothing vendored is committed — `src/content/rac-core/` is gitignored.
12+
not authored here**: `scripts/vendor-docs.sh` sparse-checks out each source
13+
repo's `docs/` directory into `docs/<slug>/` before `mkdocs build`. Nothing
14+
vendored is committed — `docs/rac-core/` is gitignored. Because it lands in
15+
the same MkDocs `docs_dir` as everything else, the source repos' existing
16+
relative links between pages (`[relationships.md](relationships.md)`, `cli.md#schema`,
17+
etc.) resolve correctly with no rewriting.
1418

1519
The rationale and contract are recorded in `rac-core`'s
1620
[ADR-101](https://github.com/itsthelore/rac-core/blob/main/rac/decisions/adr-101-org-docs-site-and-topology.md).
1721

22+
Brand assets (`overrides/home.html`, `docs/stylesheets/extra.css`,
23+
`docs/fonts/`, `docs/images/favicon.png` + `lamplighter.png`) are one-time
24+
copies of `rac-core`'s `rac-localview` design system (see that repo's
25+
`rac-localview/DESIGN.md` for the underlying rules) and its existing MkDocs
26+
theme setup — this org site now owns the canonical copies per ADR-092
27+
("the brand lives at the org").
28+
1829
Adding a new product section:
1930

20-
1. Add an entry to `vendor.config.json` (`slug`, `repo`, `ref`, `path`).
21-
2. Add a matching collection in `src/content.config.ts`.
22-
3. Add `src/pages/<slug>/index.astro` and `src/pages/<slug>/[...slug].astro`
23-
(copy the `rac-core` versions as a starting point).
31+
1. Add a `vendor_repo <slug> <repo> <ref> <path>` line to
32+
`scripts/vendor-docs.sh`.
33+
2. Add its pages to the `nav:` list in `mkdocs.yml`.
34+
3. Add a card to the "constellation" grid in `docs/index.md`.
2435

2536
## Local development
2637

2738
```sh
28-
npm install
29-
npm run dev
39+
pip install mkdocs==1.6.1 mkdocs-material==9.7.6
40+
./scripts/vendor-docs.sh
41+
mkdocs serve
3042
```
31-
32-
`npm run dev` and `npm run build` both vendor fresh content first.

astro.config.mjs

Lines changed: 0 additions & 11 deletions
This file was deleted.
50.6 KB
Binary file not shown.

docs/fonts/InterVariable.woff2

47.1 KB
Binary file not shown.
38.7 KB
Binary file not shown.
37.5 KB
Binary file not shown.

docs/fonts/OFL.txt

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
https://openfontlicense.org
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

docs/images/favicon.png

2.16 KB
Loading

0 commit comments

Comments
 (0)