Skip to content

Merge pull request #1 from SylphAI-Inc/docs/quickstart-title-update#2

Open
Tanglumy wants to merge 183 commits intodocs/quickstart-title-updatefrom
main
Open

Merge pull request #1 from SylphAI-Inc/docs/quickstart-title-update#2
Tanglumy wants to merge 183 commits intodocs/quickstart-title-updatefrom
main

Conversation

@Tanglumy
Copy link
Collaborator

docs: update FAQ links to include issues page and LinkedIn

Tanglumy and others added 30 commits November 26, 2025 16:43
docs: update FAQ links to include issues page and LinkedIn
docs: simplify installation guide - remove setup and platform notes
## Changes

### Documentation Structure
- Add Input Methods guide (text, images, files/directories)
- Restructure MCP documentation (479 lines → 138 lines, clearer structure)
- Add \"How to leverage MCP\" advisory guide for personal/team workflows
- Archive old MCP docs for reference

### Site Configuration
- Upgrade Docusaurus to 3.9.2
- Add local search plugin
- Set docs as homepage (slug: /)
- Add dark mode logo
- Flatten sidebar navigation (sidebarCollapsible: false)
- Update navbar with section links (Getting Started, Features, Troubleshooting)

### Category Labels
- Add _category_.json for proper sidebar labels
- Getting Started, Features, Troubleshooting now display correctly

### AGENTS.md
- Add repo guidance for working with docs site

Co-Authored-By: AdaL <adal@sylph.ai>
Render deploy failed because Docusaurus 3.9.2 requires Node.js >=20.0.
- Update engines in package.json
- Add .node-version and .nvmrc files

Co-Authored-By: AdaL <adal@sylph.ai>
docs: Restructure documentation site with improved UX
The render.yaml blueprint was setting NODE_VERSION=18.20.0,
which overrides file-based configs. Docusaurus 3.9.2 requires Node.js >=20.

Co-Authored-By: AdaL <adal@sylph.ai>
fix: Update NODE_VERSION to 20 in render.yaml
slash-commands.md was linking to mcp-support.md which was archived.
Updated to point to mcp-support-proposed.md (the new MCP doc).

Co-Authored-By: AdaL <adal@sylph.ai>
fix: Update broken link to archived MCP doc
Removed @easyops-cn/docusaurus-search-local - only works after build,
not in dev mode, causing confusion.

Co-Authored-By: AdaL <adal@sylph.ai>
fix: Remove non-functional search plugin
- Add JetBrains Mono font for terminal feel, Space Grotesk for headings
- Smaller heading sizes with tighter letter-spacing
- Glassmorphism navbar with backdrop blur
- Consistent dark/light mode backgrounds
- Modern tables, code blocks, admonitions styling
- Clean footer with Company/Community/More sections
- Improved spacing, typography, and visual hierarchy
- Neutral bullet markers, refined blockquotes
- Better focus states and hover effects

Co-Authored-By: AdaL <adal@sylph.ai>
- Content max-width (800px) for optimal readability
- Cleaner link styling with subtle underline
- Neutral sidebar/TOC active states (no gray highlight)
- Neutral hover states throughout (tables, pagination, search)
- Professional button styling
- Reduced green accent to interactive elements only
- Better light mode support for all components
- Subtle scrollbar and selection colors

Co-Authored-By: AdaL <adal@sylph.ai>
- Simple, clean guide for using personal API keys
- Covers Anthropic, OpenAI, Google providers
- Quick start, commands, dialog shortcuts
- Per-provider billing explanation
- Security notes

Co-Authored-By: AdaL <adal@sylph.ai>
…umns

- Removed fixed table layout for natural column sizing
- Border-collapse for cleaner borders
- Refined padding, typography, and hover states
- Proper light/dark mode variants

Co-Authored-By: AdaL <adal@sylph.ai>
Modern UI/UX overhaul & BYOAK documentation
- Updated input-methods.md table to show @ reference and description on separate lines
- Uses <br/> for proper line breaks in table cells

Co-Authored-By: AdaL <adal@sylph.ai>
docs: Fix file reference display format
…ntegration

- Add models.md: Model configuration and supported providers
- Add manage-conversations.md: Session and conversation management features
- Update input-methods.md: Enhanced input methods documentation
- Update workflows-and-examples.md: Improved workflow examples
- Update mcp-integration.md: Better MCP server integration docs
- Add screenshots for features and getting-started sections

Co-Authored-By: AdaL <adal@sylph.ai>
Add documentation for models, input methods, conversations, and MCP integration
Use correct path with 03-features prefix for Docusaurus resolution.

Co-Authored-By: AdaL <adal@sylph.ai>
Clarify that users can use any terminal (macOS, Linux, or IDE like VS Code).

Co-Authored-By: AdaL <adal@sylph.ai>
Replace REST endpoint example with codebase summary/init example.

Co-Authored-By: AdaL <adal@sylph.ai>
Split into separate prompts: greeting, summarize, /init command.

Co-Authored-By: AdaL <adal@sylph.ai>
Update Quickstart with improved examples
- Add new plugins-and-skills.md documentation covering skill system overview
- Update workflows-and-examples.md with improved content

Co-Authored-By: AdaL <adal@sylph.ai>
mengliu1998 and others added 30 commits February 27, 2026 16:36
- Align /model screenshot section with current UI (Providers vs Third Party Subscriptions)
- Update OpenAI model list/counts and restore GPT-5.2 in docs
- Add ChatGPT Subscription section and link to setup guide
- Update docs-site changelog for 0.8.4

Co-Authored-By: AdaL <adal@sylph.ai>
docs: update models page for OpenAI + ChatGPT Subscription
Co-Authored-By: AdaL <adal@sylph.ai>
- Remove /auth from slash commands reference table
- Update /about description to reflect it now shows version, auth status, and system info

Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
- update recommended table ordering/reasons to match current /model UI
- simplify provider section to model names only
- fix OpenAI and Z.ai model lists to match supported registry entries

Co-Authored-By: AdaL <adal@sylph.ai>
- add GPT-5.4 to OpenAI model list and update count
- update 0.9.0 changelog date to 2026-03-05
- mention GPT-5.4 alongside GPT-5.3 Codex in changelog

Co-Authored-By: AdaL <adal@sylph.ai>
- add /subagent to slash commands quick reference table
- describe subagent configuration and toggle behavior

Co-Authored-By: AdaL <adal@sylph.ai>
docs: finalize v0.9.0 models and changelog updates
Co-Authored-By: AdaL <adal@sylph.ai>
docs: update slash-commands and add v0.9.1 changelog
Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
- Remove direct AdaL Web mentions from Welcome page
- Remove AdaL Web launch section/link from Quickstart
- Mark AdaL Web page title/description as Preview

Co-Authored-By: AdaL <adal@sylph.ai>
docs: de-emphasize AdaL Web in getting started docs
- update quickstart workspace commands to worktree
- update workflows examples from workspace to worktree
- include 0.9.4 changelog notes for help/worktree/headless model flags

Co-Authored-By: AdaL <adal@sylph.ai>
docs: align 0.9.4 docs with worktree rename and changelog
- add 0.9.5 release note for improved GLM request reliability

Co-Authored-By: AdaL <adal@sylph.ai>
- note MCP servers readiness status fix after authentication

Co-Authored-By: AdaL <adal@sylph.ai>
- add GLM-5-Turbo to Z.ai model list and update model count
- include v0.9.7 changelog notes

Co-Authored-By: AdaL <adal@sylph.ai>
docs: update v0.9.7 model docs and changelog
- note Claude streaming reliability improvements
- clarify rate limit error messaging improvements

Co-Authored-By: AdaL <adal@sylph.ai>
- add MiniMax M2.7 and M2.7 Highspeed in Models page
- add /permissions command to Slash Commands quick reference
- include 0.9.9 changelog updates

Co-Authored-By: AdaL <adal@sylph.ai>
docs: align 0.9.9 models and slash commands docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants