Restructure README with table of contents, benchmarks table, and expanded documentation#1935
Restructure README with table of contents, benchmarks table, and expanded documentation#1935nityatimalsina wants to merge 1 commit intomainfrom
Conversation
…nded documentation Add comprehensive table of contents, convert benchmark data to table format, expand use cases section with AI agents/scraping/testing examples, add architecture diagram reference, reorganize build/test sections with collapsible details, and include FAQ section. Improve formatting throughout with horizontal rules and better section hierarchy.
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
| ./lightpanda fetch --obey_robots --log_format pretty --log_level info https://demo-browser.lightpanda.io/campfire-commerce/ | ||
| ``` | ||
|
|
||
| <details> |
There was a problem hiding this comment.
I know this isn't your edit, but the above command needs a --dump flag.
|
|
||
| ## Architecture | ||
|
|
||
|  |
There was a problem hiding this comment.
This diagram is not correct. There's no libdom, there's no zig-js-runtimes. "computed style sheet" is a huge stretch. Is "Lightpanda Server" referencing a hosted option / layer? Not a term I've heard before.
Nicolas0315
left a comment
Nicolas0315
left a comment
There was a problem hiding this comment.
Coordination note from PR #1954
Hey @nityatimalsina — great work on the README restructure! I've got a related PR (#1954) that adds docs/cdp-serve-guide.md and docs/ai-agent-integration.md to a new docs/ directory.
A few thoughts on how these could work together:
What this PR does well
- The TOC is a big improvement — the current README is hard to navigate
- Collapsible build/test sections keep the README scannable
- FAQ section is useful for newcomers
Suggestions to avoid overlap
-
Link to
docs/from the README — If #1954 lands, the README's "AI Agent Integration" and "Advanced Configuration" sections could link to the detailed docs rather than duplicating content. This keeps the README as an overview anddocs/as the deep dive. -
Benchmarks table format — Your table format is cleaner than the current bullet list. One addition: memory usage per concurrent page count would be very useful for AI agent users (the #1 question we see). We have real measurements in
docs/ai-agent-integration.md:Pages Lightpanda Chrome Ratio 1 ~7 MB ~280 MB 40x 10 ~70 MB ~2.8 GB 40x 100 ~696 MB ~4.2 GB 6x -
Architecture diagram — You reference an architecture diagram. We could collaborate on this — our
docs/ai-agent-integration.mdhas an ASCII architecture diagram showing the CDP integration pattern that could be a starting point.
Happy to coordinate so we don't step on each other's toes. 🤝
|
closed in favor of #2114 2114 |
4 participants
Add table of contents, convert benchmark data to table format, expand use cases section with AI agents/scraping/testing examples, add architecture diagram reference, reorganize build/test sections with collapsible details, and include FAQ section. Improve formatting throughout with horizontal rules and better section hierarchy.