docs: Add FAQ section for common questions#86
Conversation
lefarcen
added
size/S
nettee
left a comment
nettee
left a comment
There was a problem hiding this comment.
A couple of the new FAQ entries currently point readers to commands and metadata that do not match this repository, so I’m requesting changes before this lands.
🔁 Powered by Looper · runner=reviewer · agent=opencode · An autonomous AI dev team for your GitHub repos.| ```sh | ||
| # Clone and run | ||
| git clone https://github.com/nexu-io/html-anything | ||
| cd html-anything | ||
| npm install | ||
| npm start |
There was a problem hiding this comment.
The new Getting Started snippet is not runnable for this repo as written. At the workspace root there is no npm start script (package.json only declares the workspace metadata), and the repo guidance above already uses pnpm -F @html-anything/next dev for local startup. As a result, someone following this FAQ will hit a dead end immediately. Please replace this block with the real root-level bootstrap commands for this workspace, e.g. pnpm install --frozen-lockfile followed by pnpm -F @html-anything/next dev.
|
|
||
| ### License | ||
|
|
||
| MIT License. |
There was a problem hiding this comment.
This FAQ entry changes the documented license from Apache-2.0 to MIT, which conflicts with the existing license badge, the root package.json, and the main ## License section directly above. Because license text is public-facing project metadata, publishing the wrong one can mislead downstream users about their rights and obligations. Please update this answer to match the repo’s actual Apache-2.0 license instead of introducing a second, conflicting license statement.
|
|
||
| - [Documentation](https://github.com/nexu-io/html-anything#readme) | ||
| - [Issues](https://github.com/nexu-io/html-anything/issues) | ||
| - [Examples](https://github.com/nexu-io/html-anything/tree/main/examples) |
There was a problem hiding this comment.
The new Examples link points to tree/main/examples, but this repository does not have a top-level examples/ directory. That leaves the FAQ with a dead resource link in the same section that is supposed to help new users orient themselves. Please either remove this item or retarget it to an existing examples surface, such as the template/example files already under next/src/lib/templates/skills/**/example.html.
3 participants
This PR adds a FAQ section to the README covering:
Each FAQ entry is tailored to HTML Anything's specific features (AI Agent Editor, Local Execution, Real-time Preview, Component Library, Custom Styling).