Skip to content

Commit 7f6fda0

Browse files
sij411sij411
committed
Add VitePress documentation site
Add documentation pages, a theme based on DrFed's existing visual style, and mise tasks for development, builds, and previews. Include the VitePress dependency, lockfile update, project logo, and generated-output ignore rules. AI provenance: I asked Codex to create a VitePress docs directory and apply DrFed's visual style after reading CONTRIBUTING.md. Codex generated the configuration, theme, initial documentation, and workflow integration. I revised the home page and replaced the getting-started guide with a manual-installation page. Codex updated navigation to match and corrected a typo. Codex verified the documentation and application builds and repository checks. Assisted-by: Codex:gpt-6-sol
1 parent 4336c59 commit 7f6fda0

12 files changed

Lines changed: 1802 additions & 68 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ __generated__/
99
mise.local.toml
1010
node_modules/
1111
packages/*/dist/
12+
docs/.vitepress/cache/
13+
docs/.vitepress/dist/
1214

1315
index.db
1416

‎README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,14 @@ broke, whether that's DNS, TLS, HTTP, signatures, or JSON-LD processing.
2020
[AGPLv3]: https://www.gnu.org/licenses/agpl-3.0.html
2121
[ActivityPub]: https://www.w3.org/TR/activitypub/
2222
[Fedify]: https://fedify.dev/
23+
24+
25+
Documentation
26+
-------------
27+
28+
The documentation site lives in *docs/* and uses [VitePress]. After
29+
`mise install`, run `mise run dev:docs` to start it locally. Run
30+
`mise run build:docs` to build the static site and `mise run preview:docs` to
31+
preview the result.
32+
33+
[VitePress]: https://vitepress.dev/

‎docs/.vitepress/config.mts‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// DrFed: A web-based platform for developing and debugging ActivityPub apps
2+
// Copyright (C) 2026 DrFed team
3+
//
4+
// This program is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU Affero General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// This program is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU Affero General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU Affero General Public License
15+
// along with this program. If not, see <https://www.gnu.org/licenses/>.
16+
17+
import { defineConfig } from "vitepress";
18+
19+
export default defineConfig({
20+
lang: "en-US",
21+
title: "DrFed",
22+
description:
23+
"Documentation for DrFed, a web-based platform for developing and debugging ActivityPub apps.",
24+
head: [["link", { rel: "icon", type: "image/svg+xml", href: "/icon.svg" }]],
25+
themeConfig: {
26+
logo: { src: "/icon.svg", alt: "" },
27+
nav: [{ text: "Installation", link: "/installation/manual-installation" }],
28+
sidebar: [
29+
{
30+
text: "Installation",
31+
items: [
32+
{
33+
text: "Manual installation",
34+
link: "/installation/manual-installation",
35+
},
36+
],
37+
},
38+
],
39+
search: { provider: "local" },
40+
socialLinks: [
41+
{ icon: "github", link: "https://github.com/fedify-dev/drfed" },
42+
],
43+
editLink: {
44+
pattern: "https://github.com/fedify-dev/drfed/edit/main/docs/:path",
45+
},
46+
footer: {
47+
message: "Licensed under the GNU AGPL v3 or later.",
48+
copyright: "Copyright © 2026 DrFed team",
49+
},
50+
},
51+
});

‎docs/.vitepress/theme/custom.css‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
/*
2+
DrFed: A web-based platform for developing and debugging ActivityPub apps
3+
Copyright (C) 2026 DrFed team
4+
5+
This program is free software: you can redistribute it and/or modify
6+
it under the terms of the GNU Affero General Public License as published by
7+
the Free Software Foundation, either version 3 of the License, or
8+
(at your option) any later version.
9+
10+
This program is distributed in the hope that it will be useful,
11+
but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
GNU Affero General Public License for more details.
14+
15+
You should have received a copy of the GNU Affero General Public License
16+
along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
*/
18+
19+
:root {
20+
--vp-font-family-base: system-ui, -apple-system, "Segoe UI", sans-serif;
21+
--vp-font-family-mono:
22+
ui-monospace, "SFMono-Regular", Menlo, Consolas, monospace;
23+
--drfed-font-serif: Georgia, "Times New Roman", serif;
24+
25+
--vp-c-bg: #fdfcfb;
26+
--vp-c-bg-alt: #f4f2f0;
27+
--vp-c-bg-elv: #ffffff;
28+
--vp-c-bg-soft: #f5f3f1;
29+
--vp-c-text-1: #26211f;
30+
--vp-c-text-2: #6a615c;
31+
--vp-c-text-3: #756b65;
32+
--vp-c-divider: #e9e5e1;
33+
--vp-c-border: #dad4cf;
34+
--vp-c-gutter: #e9e5e1;
35+
--vp-c-brand-1: #b83254;
36+
--vp-c-brand-2: #c23a5c;
37+
--vp-c-brand-3: #b83254;
38+
--vp-c-brand-soft: #f7e3e7;
39+
--vp-c-default-1: #dad4cf;
40+
--vp-c-default-2: #e9e5e1;
41+
--vp-c-default-3: #f4f2f0;
42+
--vp-c-default-soft: #f4f2f0;
43+
44+
--vp-home-hero-name-color: var(--vp-c-brand-1);
45+
--vp-button-alt-border: var(--vp-c-border);
46+
--vp-button-alt-hover-border: var(--vp-c-brand-1);
47+
--vp-nav-height: 68px;
48+
}
49+
50+
.dark {
51+
--vp-c-bg: #181613;
52+
--vp-c-bg-alt: #1e1b17;
53+
--vp-c-bg-elv: #201d19;
54+
--vp-c-bg-soft: #272420;
55+
--vp-c-text-1: #f0ece8;
56+
--vp-c-text-2: #bab1aa;
57+
--vp-c-text-3: #a39990;
58+
--vp-c-divider: #332f2a;
59+
--vp-c-border: #453f39;
60+
--vp-c-gutter: #332f2a;
61+
--vp-c-brand-1: #f78da4;
62+
--vp-c-brand-2: #ef6a88;
63+
--vp-c-brand-3: #f78da4;
64+
--vp-c-brand-soft: #322a27;
65+
--vp-c-default-1: #453f39;
66+
--vp-c-default-2: #332f2a;
67+
--vp-c-default-3: #272420;
68+
--vp-c-default-soft: #272420;
69+
--vp-button-brand-text: #26211f;
70+
--vp-button-brand-hover-text: #26211f;
71+
--vp-button-brand-active-text: #26211f;
72+
}
73+
74+
.VPNavBarTitle .title {
75+
font-family: var(--drfed-font-serif);
76+
font-size: 24px;
77+
letter-spacing: -0.03em;
78+
}
79+
80+
.VPNavBarTitle .logo {
81+
height: 32px;
82+
border-radius: 50%;
83+
}
84+
85+
.VPHero .name {
86+
font-family: var(--vp-font-family-mono);
87+
font-size: 14px;
88+
font-weight: 500;
89+
letter-spacing: 0.14em;
90+
line-height: 1.6;
91+
text-transform: uppercase;
92+
}
93+
94+
.VPHero .text {
95+
margin-top: 20px;
96+
max-width: 760px;
97+
font-family: var(--drfed-font-serif);
98+
font-size: clamp(40px, 5.5vw, 72px);
99+
font-weight: 400;
100+
letter-spacing: -0.045em;
101+
line-height: 1.08;
102+
}
103+
104+
.VPHero .tagline {
105+
max-width: 540px;
106+
padding-top: 24px;
107+
font-size: 18px;
108+
line-height: 1.65;
109+
}
110+
111+
.VPButton {
112+
border-radius: 999px;
113+
}
114+
115+
.VPFeature {
116+
border-color: var(--vp-c-divider);
117+
border-radius: 14px;
118+
background: var(--vp-c-bg-elv);
119+
}
120+
121+
.VPFeature .title {
122+
font-family: var(--drfed-font-serif);
123+
font-size: 22px;
124+
font-weight: 400;
125+
letter-spacing: -0.02em;
126+
}
127+
128+
.VPFeature .details {
129+
margin-top: 8px;
130+
line-height: 1.7;
131+
}
132+
133+
.vp-doc h1,
134+
.vp-doc h2 {
135+
font-family: var(--drfed-font-serif);
136+
font-weight: 400;
137+
letter-spacing: -0.025em;
138+
}
139+
140+
.vp-doc h1 {
141+
font-size: clamp(34px, 4vw, 44px);
142+
line-height: 1.15;
143+
}
144+
145+
.vp-doc h2 {
146+
font-size: 28px;
147+
}
148+
149+
.vp-doc p,
150+
.vp-doc li {
151+
line-height: 1.75;
152+
}
153+
154+
.vp-doc div[class*="language-"] {
155+
border: 1px solid var(--vp-c-divider);
156+
border-radius: 12px;
157+
}
158+
159+
.VPSidebarItem.is-active > .item .link > .text {
160+
font-weight: 700;
161+
}
162+
163+
.VPFooter {
164+
background: var(--vp-c-bg-alt);
165+
}

‎docs/.vitepress/theme/index.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// DrFed: A web-based platform for developing and debugging ActivityPub apps
2+
// Copyright (C) 2026 DrFed team
3+
//
4+
// This program is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU Affero General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// This program is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU Affero General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU Affero General Public License
15+
// along with this program. If not, see <https://www.gnu.org/licenses/>.
16+
17+
import DefaultTheme from "vitepress/theme-without-fonts";
18+
19+
import "./custom.css";
20+
21+
export default DefaultTheme;

‎docs/index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: home
3+
4+
hero:
5+
name: ActivityPub Debugging Platform
6+
text: Debugging tools for the fediverse.
7+
tagline: DrFed is a web-based platform for developing and debugging ActivityPub implementations—inspecting objects and activities, and tracing where federation fails. It is built by the team behind Fedify.
8+
actions:
9+
- theme: brand
10+
text: Install
11+
link: /installation/manual-installation
12+
- theme: alt
13+
text: View on GitHub
14+
link: https://github.com/fedify-dev/drfed
15+
16+
features:
17+
- title: Contribute to DrFed
18+
details: Find package boundaries, coding conventions, and required checks.
19+
link: https://github.com/fedify-dev/drfed/blob/main/CONTRIBUTING.md
20+
linkText: Contributor guide
21+
---
22+

‎docs/installation/manual-installation.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Manual installation
2+
===================
3+
4+
Run DrFed on your own server to develop and debug ActivityPub apps.

0 commit comments

Comments
 (0)