Repository navigation
docs site: user-friendly mdBook at journal.eamann.com (Catppuccin Latte) + warmer prose - #38
Merged
Merged
Conversation
Adds a user-facing documentation site in book/ with Catppuccin Latte as the default theme, deployed to GitHub Pages. Prose is rewritten for warmth and accessibility across 14 chapters covering install, capture, search, synthesis, meetings, configuration, and integrations. The docs.yml deployment workflow is staged but requires a maintainer with workflows permission to commit — see PR for the file contents. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
mdBook v0.4.40 creates a stub file for external URLs in SUMMARY.md footer sections. Move the developer docs link to the introduction page instead, where it renders as a plain hyperlink without side effects. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- preferred-dark-theme → preferred-dark-scheme (the valid mdBook key) - add [preprocessor.linkcheck] with warning-policy=error so broken internal links fail CI builds Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Retro: no durable lesson (merged clean / one-off). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 Agent-Generated PR
Closes #34
Agent Used: Claude Code
Complexity: high
Summary
Adds a user-facing documentation site at https://journal.eamann.com built with mdBook and styled with Catppuccin Latte. The existing
docs/tree is untouched — this is an additive layer written for a non-technical audience.book/src/CNAMEcarriesjournal.eamann.cominto the built artifactImplementation Notes
default-theme = "latte"matches the Catppuccin v4 CSS class names (.latte { … })preferred-dark-scheme = "mocha"is the correct mdBook key (vspreferred-dark-themewhich is silently ignored)[preprocessor.linkcheck]withwarning-policy = "error"andfollow-web-links = falsevalidates internal links without making network callsThe GitHub App token does not have
workflowswrite permission, so.github/workflows/docs.ymlcould not be committed directly. Please add the file below to complete the deployment pipeline, then merge..github/workflows/docs.yml— click to expandChanges
book/book.toml— mdBook config (Catppuccin Latte default, linkcheck)book/src/SUMMARY.md— 14-chapter IAbook/src/CNAME—journal.eamann.combook/src/*.md+book/src/integrations/*.md— all chapter pagesbook/theme/catppuccin.css— vendored Catppuccin v4.0.0book/theme/index.hbs— custom template for Catppuccin theme class support.gitignore— addbook/book/README.md— docs site badge + linkTesting
Automated:
mdbook build book/exits 0 (verified locally)make vetandmake fmtexit 0 (no Go changes)Manual testing performed:
Maintainer steps to go live
.github/workflows/docs.ymlgithub-pagesenvironment in Settings → Environments (if not already present)journal.eamann.com→ericmann.github.ioReview Checklist
Correctness
docs/tree unchangedCode Quality
Security
Tests
make testunaffected (no Go changes)