docs: update introduction for clarity and engagement#1
Open
gaurav-nelson wants to merge 1 commit into
Open
Conversation
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ❌ Deployment failed View logs |
docslit-docs | 8695750 | Jun 17 2026, 02:38 AM |
gaurav-nelson
commented
Jun 17, 2026
gaurav-nelson
left a comment
gaurav-nelson
left a comment
Contributor
Author
There was a problem hiding this comment.
DraftView review: 2 comments, 0 edits
| DocsLit is a documentation framework that combines Markdown with interactive web components. You write content in Markdown, drop in `<wc-*>` components for rich interactions, and deploy a fast static site — no build tools, no JSX, no imports. | ||
| DocsLit turns plain Markdown into polished, interactive docs that teams actually enjoy writing and users actually enjoy reading. | ||
|
|
||
| You stay in Markdown. You drop in powerful `<wc-*>` components when needed. You ship a fast documentation site without wrestling with build tools, JSX, or import chains. |
Contributor
Author
There was a problem hiding this comment.
Too many You's. Make this clearer.
Review by abc@duck.com · verified & pushed by gaurav-nelson via DraftView
| </wc-columns> | ||
|
|
||
| No imports. No build step. No configuration. The components just work because they are standard web components rendered by the browser. | ||
| No imports. No JS boilerplate. No component setup. The browser renders standard web components directly, so your authoring workflow stays clean. |
Contributor
Author
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
Yup. this is an AI generated PR.
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 pull request updates the
Introductionpage of the DocsLit documentation to improve clarity, make the messaging more engaging, and better highlight the product's benefits and workflow. The changes focus on rewriting descriptions, enhancing feature explanations, and streamlining the getting started steps to create a more inviting and informative experience for new users.Content and Messaging Improvements:
Feature Highlights and Workflow:
Getting Started Flow: