From 235c510d88ff97e7d6f4abd7be69b65c656535c2 Mon Sep 17 00:00:00 2001 From: ComputelessComputer Date: Mon, 17 Nov 2025 12:57:58 +0900 Subject: [PATCH 1/5] cleanup --- apps/web/content/docs/README.md | 120 -------------------------------- 1 file changed, 120 deletions(-) delete mode 100644 apps/web/content/docs/README.md diff --git a/apps/web/content/docs/README.md b/apps/web/content/docs/README.md deleted file mode 100644 index 0c0cd18018..0000000000 --- a/apps/web/content/docs/README.md +++ /dev/null @@ -1,120 +0,0 @@ -# Documentation Guide - -This directory contains all documentation for Hyprnote. - -## Creating Documentation - -1. Create a new MDX file: `my-doc.mdx` - -2. Add frontmatter: - -```yaml ---- -title: "Getting Started" -summary: "Quick start guide" # Optional -author: "Your Name" -created: "2025-10-30" -updated: "2025-11-01" # Optional: only if different from created -category: "Basics" # Optional: for grouping ---- -``` - -**Note**: The slug is automatically derived from the filename. For example, `getting-started.mdx` becomes slug `getting-started`. - -3. Write your documentation using Markdown/MDX - -## Documentation Structure - -Organize docs by purpose: -- **Getting Started** - Setup and installation -- **Guides** - How-to guides and tutorials -- **Reference** - API and configuration reference -- **Troubleshooting** - Common issues and solutions - -## Adding Images - -Store documentation assets in `/public/docs/`: - -``` -/public/docs/ - architecture.png - setup-screenshot.png - feature-diagram.svg -``` - -Reference in MDX: - -```markdown -![Architecture Diagram](/docs/architecture.png) -``` - -## Frontmatter Fields - -### Required -- `title` - Page title -- `author` - Author name -- `created` - Creation date (ISO format: YYYY-MM-DD) - -### Optional -- `summary` - Brief description for previews -- `updated` - Last update date (ISO format: YYYY-MM-DD) -- `category` - Grouping category for sidebar organization - -### Auto-Generated -- `slug` - Automatically derived from filename (e.g., `getting-started.mdx` → `getting-started`) - -## Features - -### Sidebar Navigation -- Automatically generated from all docs -- Shows active document -- Mobile-friendly with collapsible menu - -### Heading Anchors -All headings automatically get: -- Unique IDs for linking -- Clickable anchor links - -Link to a specific section: -```markdown -[See Installation](#installation) -``` - -## Markdown Features - -All GitHub Flavored Markdown (GFM) is supported: - -### Tables -```markdown -| Command | Description | -|---------|-------------| -| `npm start` | Start the app | -``` - -### Code Blocks -````markdown -```bash -npm install hyprnote -``` -```` - -### Callouts (using blockquotes) -```markdown -> **Note:** This is important information. -``` - -## Best Practices - -1. **Structure**: Use clear hierarchy with H2 and H3 headings -2. **Code Examples**: Always include working examples -3. **Screenshots**: Use screenshots for UI-heavy features -4. **Links**: Link to related documentation -5. **Versioning**: Update version number for major changes -6. **Categories**: Group related docs together - -## Viewing Your Docs - -- Collection page: `http://localhost:3000/docs` -- Document page: `http://localhost:3000/docs/{slug}` - -The sidebar automatically updates when you add new docs. From 488995b2dffb99d5af06fbf7ba8811f92d36bf47 Mon Sep 17 00:00:00 2001 From: ComputelessComputer Date: Mon, 17 Nov 2025 12:58:22 +0900 Subject: [PATCH 2/5] made signature image size consistent --- apps/web/content/docs/index.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/apps/web/content/docs/index.mdx b/apps/web/content/docs/index.mdx index b437c7fd49..5bdb4da94e 100644 --- a/apps/web/content/docs/index.mdx +++ b/apps/web/content/docs/index.mdx @@ -22,17 +22,15 @@ Cheers, Team Hyprnote Hyprnote Signature Hyprnote Signature From bbd79f9a91f424e93a49af9a8e44f7f167f093c5 Mon Sep 17 00:00:00 2001 From: ComputelessComputer Date: Mon, 17 Nov 2025 12:59:16 +0900 Subject: [PATCH 3/5] refactor(docs): Simplify layout and styling for documentation pages --- .../web/src/routes/_view/docs/-components.tsx | 32 +++---------------- apps/web/src/routes/_view/docs/route.tsx | 4 +-- 2 files changed, 6 insertions(+), 30 deletions(-) diff --git a/apps/web/src/routes/_view/docs/-components.tsx b/apps/web/src/routes/_view/docs/-components.tsx index 425d140fbb..2d17cf0c13 100644 --- a/apps/web/src/routes/_view/docs/-components.tsx +++ b/apps/web/src/routes/_view/docs/-components.tsx @@ -1,5 +1,4 @@ import { MDXContent } from "@content-collections/mdx/react"; -import { Icon } from "@iconify-icon/react"; import { Link } from "@tanstack/react-router"; import { allDocs } from "content-collections"; @@ -26,15 +25,13 @@ export function DocLayout({ }) { return ( <> -
+
- - ); } @@ -61,7 +58,7 @@ function ArticleHeader({ {sectionTitle} )} -

+

{doc.title}

{doc.summary && ( @@ -104,7 +101,7 @@ function ArticleHeader({ function ArticleContent({ doc }: { doc: any }) { return ( -
+
; }) { return ( -