docs: add comprehensive onboarding documentation for new users#1437
Open
vincent067 wants to merge 1 commit into
Open
docs: add comprehensive onboarding documentation for new users#1437vincent067 wants to merge 1 commit into
vincent067 wants to merge 1 commit into
Conversation
Add three new documentation files to help new users get started: 1. getting-started.md - Complete onboarding guide covering: - Project introduction and features - All deployment options (online, browser extension, Docker, CLI) - Quick start instructions for each method - Getting help section 2. markdown-guide.md - Comprehensive syntax reference: - Basic Markdown syntax - Extended features (GFM alerts, footnotes, etc.) - Math formulas (LaTeX/KaTeX) - Diagrams (Mermaid, PlantUML) - Ruby annotations for Chinese/Japanese - WeChat-specific formatting tips 3. example-content.md - Ready-to-use templates: - Technical tutorial template - Product announcement template - Weekly newsletter template - Academic article template (with Chinese example) Also updated docs/README.md with new documentation index. Addresses doocs#678
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
1 participant
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.
This PR adds comprehensive onboarding documentation to help new users get started with the project.
Changes
Added three new documentation files:
getting-started.md - Complete onboarding guide covering:
markdown-guide.md - Comprehensive syntax reference:
example-content.md - Ready-to-use templates:
Also updated docs/README.md with new documentation index.
Closes #678