docs: rebuild documentation from scratch with clean IA

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Justin Visser 2026-02-27 09:39:27 +01:00
parent 6c31b331f7
commit 0c5b199b76
30 changed files with 1647 additions and 649 deletions

View file

@ -2,8 +2,8 @@
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "scholarr",
tagline: "Self-hosted scholar tracking docs",
title: "Scholarr",
tagline: "Self-hosted academic publication tracker",
favicon: "img/favicon.ico",
url: "https://justinzeus.github.io",
@ -23,59 +23,52 @@ const config = {
presets: [
[
"classic",
{
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
path: "..",
exclude: ["website/**", "README.md"],
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/JustinZeus/scholarr/tree/main/",
exclude: ["website/**", "README.md"],
},
blog: false,
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
}),
],
],
themeConfig: {
navbar: {
title: "scholarr",
items: [
{
type: "docSidebar",
sidebarId: "docsSidebar",
position: "left",
label: "Docs",
},
{
href: "https://github.com/JustinZeus/scholarr",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
title: "Docs",
items: [{ label: "Index", to: "/" }],
},
{
title: "Community",
items: [
{
label: "GitHub",
href: "https://github.com/JustinZeus/scholarr",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} scholarr.`,
},
},
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: "Scholarr",
items: [
{ to: "/user/overview", label: "User Guide", position: "left" },
{
to: "/developer/overview",
label: "Developer",
position: "left",
},
{
to: "/operations/overview",
label: "Operations",
position: "left",
},
{ to: "/reference/overview", label: "Reference", position: "left" },
{
href: "https://github.com/JustinZeus/scholarr",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
copyright: `Copyright \u00a9 ${new Date().getFullYear()} Scholarr. Built with Docusaurus.`,
},
}),
};
module.exports = config;

View file

@ -1,18 +1,27 @@
{
"name": "scholarr-docs",
"version": "0.0.1",
"version": "0.1.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve"
},
"dependencies": {
"@docusaurus/core": "3.9.2",
"@docusaurus/preset-classic": "3.9.2",
"clsx": "^2.1.1",
"prism-react-renderer": "^2.3.1",
"@docusaurus/core": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.0.0"
},
"browserslist": {
"production": [">0.5%", "not dead", "not op_mini all"],
"development": ["last 1 chrome version", "last 1 firefox version", "last 1 safari version"]
}
}

View file

@ -1,38 +1,49 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
docsSidebar: [
docs: [
"index",
{
type: "category",
label: "Users",
items: ["user/overview", "user/getting-started"],
label: "User Guide",
items: [
"user/overview",
"user/getting-started",
"user/configuration",
],
},
{
type: "category",
label: "Developer",
items: [
"developer/overview",
"developer/architecture",
"developer/local-development",
"developer/contributing",
"developer/ingestion",
"developer/frontend-theme-inventory",
"developer/testing",
],
},
{
type: "category",
label: "Operations",
items: [
"operations/overview",
"operations/scrape-safety-runbook",
"operations/deployment",
"operations/database-runbook",
"operations/migration-checklist",
],
},
{
type: "category",
label: "Developers",
items: [
"developer/overview",
"developer/documentation-standards",
"developer/local-development",
"developer/architecture",
"developer/contributing",
"developer/frontend-theme-inventory",
"operations/scrape-safety-runbook",
"operations/arxiv-runbook",
],
},
{
type: "category",
label: "Reference",
items: ["reference/overview", "reference/api-contract", "reference/environment"],
items: [
"reference/overview",
"reference/api",
"reference/environment",
"reference/changelog",
],
},
],
};

View file

@ -1,9 +1,22 @@
:root {
--ifm-color-primary: #2a6b4e;
--ifm-color-primary-dark: #255f46;
--ifm-color-primary-darker: #225942;
--ifm-color-primary-darkest: #1c4936;
--ifm-color-primary-light: #2f7756;
--ifm-color-primary-lighter: #327d5a;
--ifm-color-primary-lightest: #3b946b;
--ifm-color-primary: #2e8555;
--ifm-color-primary-dark: #29784c;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
--ifm-color-primary-light: #33925d;
--ifm-color-primary-lighter: #359962;
--ifm-color-primary-lightest: #3cad6e;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
[data-theme="dark"] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
--ifm-color-primary-light: #29d5b0;
--ifm-color-primary-lighter: #32d8b4;
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB