Skip to content

Comments

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

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

Merge pull request #1 from SylphAI-Inc/docs/quickstart-title-update#2
Tanglumy wants to merge 141 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 2, 2026 22:45
Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
- Remove Tab thinking toggle from quickstart and keyboard shortcuts
- Remove Thinking Mode section from keyboard shortcuts
- Update model pool: add Claude Opus 4.6 and Opus 4.6 (1M)
- Remove Thinking tags from all models, remove Preview from Gemini
- Rename Thinking Models to Adaptive Thinking
- Update extended context model list

Co-Authored-By: AdaL <adal@sylph.ai>
- Update Follow AdaL link to https://x.com/adalengineer
- Include changelog updates

Co-Authored-By: AdaL <adal@sylph.ai>
docs: update for v0.6.3 - remove thinking toggle, update model pool
- Rewrite README with key highlights, badges, quick install
- Update docs site URL to docs.sylph.ai
- Add X/Twitter @adalengineer link
- Use static Discord badge
- Move Docusaurus mention to footer
- Update tagline to self-evolving agent

Co-Authored-By: AdaL <adal@sylph.ai>
- Quickstart: split Launch into Terminal UI and Browser UI sections
- Welcome: add one-liner mentioning both interfaces
- New page: 01-getting-started/adal-web.md with features, comparison, config
- Cross-links from quickstart to adal-web page

Co-Authored-By: AdaL <adal@sylph.ai>
- Update command syntax to use -b flag: adal workspace create -b <name>
- Add start-point parameter for creating from specific branches
- Rename remove to delete to match CLI
- Document .adal_workspace_config and automatic .env copying
- Add examples for remote branch and force delete

Co-Authored-By: AdaL <adal@sylph.ai>
docs: update workspace command docs to match latest CLI
Set defaultMode to dark and disable respectPrefersColorScheme.
Users can still toggle light/dark mode via the navbar button.

Co-Authored-By: AdaL <adal@sylph.ai>
feat: force dark mode as default theme
- Add terminal setup link in quickstart Launch section
- Add AGENTS.md creation feature to adal-web Available Now list
- Update changelog

Co-Authored-By: AdaL <adal@sylph.ai>
docs: update quickstart and adal-web for v0.7.1
- Add clickable YouTube thumbnail to README
- Add YouTube link to welcome page

Co-Authored-By: AdaL <adal@sylph.ai>
- Use clickable thumbnail with text link below

Co-Authored-By: AdaL <adal@sylph.ai>
docs: add YouTube demo to README and welcome page
- Add new 03-features/local-models.md with full Ollama setup guide
- Update models.md with brief local models section and new /model UI

Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
- Rename local-models.md to _local-models.md (Docusaurus ignores _ prefix)
- Restructure models.md: Recommended table + All Models by Provider sections
- Move pricing details to Billing section with provider pricing links
- Update model counts: OpenAI (10), removed Ollama from UI example
- Rename page title to Models & Billing

Co-Authored-By: AdaL <adal@sylph.ai>
- Replace Gemini 3 Pro with 3.1 Pro in recommended list
- Update model counts and descriptions
- Add 3.1 Pro to extended context list

Co-Authored-By: AdaL <adal@sylph.ai>
Co-Authored-By: AdaL <adal@sylph.ai>
add v0.8.0 changelog, add local models (Ollama) guide and update /model selector
- Add v0.8.1 and v0.8.2 changelog entries
- Uncomment local models page (rename from _local-models.md to local-models.md)
- Remove draft status from local models page
- Add Local Models section back to models.md

Co-Authored-By: AdaL <adal@sylph.ai>
docs: update for v0.8.1 - add changelog, uncomment local models
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.

5 participants