Merge pull request #1 from SylphAI-Inc/docs/quickstart-title-update#2
Open
Tanglumy wants to merge 217 commits intodocs/quickstart-title-updatefrom
Open
Merge pull request #1 from SylphAI-Inc/docs/quickstart-title-update#2Tanglumy wants to merge 217 commits intodocs/quickstart-title-updatefrom
Tanglumy wants to merge 217 commits intodocs/quickstart-title-updatefrom
Conversation
docs: update FAQ links to include issues page and LinkedIn
docs: simplify installation guide - remove setup and platform notes
docs: update Quickstart title
## 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>
Fix broken link in models.md
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>
- update navbar Troubleshooting link from removed page - point to /getting-started/quickstart to avoid broken-link build failure Co-Authored-By: AdaL <adal@sylph.ai>
- remove stale Troubleshooting nav entry after deleting installation page - keep top nav focused on active docs sections Co-Authored-By: AdaL <adal@sylph.ai>
fix(docs): resolve broken troubleshooting link causing deploy failure
docs: Add Deep Research feature documentation
Co-Authored-By: AdaL <adal@sylph.ai>
docs(changelog): add 1.0.1 release notes
Refresh the public MCP documentation with the current workflow, including improved add/auth flows, custom server setup options, and updated examples. Co-Authored-By: AdaL <adal@sylph.ai>
docs: update MCP workflow guide
- Add /permissions section in slash commands with approval configuration guidance - Cross-link auto-accept docs to /permissions for discoverability - Correct keyboard shortcuts to reflect Tab mode cycle and Shift+Tab auto-accept edits - Add Tab mode-cycle explanation and autocomplete caveat for / and @ inputs Co-Authored-By: AdaL <adal@sylph.ai>
docs: document /permissions and fix Tab/Shift+Tab shortcuts
Add a beginner-friendly section with copy-paste starter prompts and a sample output shape to reduce first-use friction and improve time-to-value for new users. Co-Authored-By: Marium
Add a raw “day-one” prompt plus a short note clarifying that messy prompts are valid and can be refined after the first pass. Co-Authored-By: AdaL <adal@sylph.ai>
- Add dedicated feature page for /cron with use cases: training monitoring, data pipeline babysitting, literature search - Add interactive dialog and interval preset documentation - Add /cron to slash commands quick reference table - Add tip about /cron in slash commands page Co-Authored-By: AdaL <adal@sylph.ai>
…ompts docs: add starter prompts and sample output for Deep Research
docs: add /cron scheduled prompts user-facing documentation
Docs linux copy troubleshooting
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
8 participants
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.
docs: update FAQ links to include issues page and LinkedIn