Skip to content

docs: add docs directory for nuxt.com/modules/icon - #554

Draft
atinux wants to merge 3 commits into
mainfrom
docs
Draft

atinux wants to merge 3 commits into
mainfrom
docs

Conversation

@atinux

@atinux atinux commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

Opened by an AI agent (Amp) on behalf of @atinux, as a draft to iterate on.

Resolves #466

Adds a docs/ directory so nuxt.com can host the Nuxt Icon docs under its module page, e.g. nuxt.com/modules/icon/configuration (nuxt.com side: nuxt/nuxt.com#2550).

The pages are split from the README, so the README is left unchanged for now:

  • index.md: overview, rendered at /modules/icon instead of the README. Its title is Nuxt Icon for agents and search; navigation.title keeps Overview in the sidebar
  • 1.getting-started/: installation, usage
  • 2.guide/: custom collections, customization, server and client bundles, Vite plugin, render function, testing
  • 3.configuration.md: options table, taken from src/schema.ts

Links between pages use their nuxt.com paths (/modules/icon/...). Until this is merged, the nuxt.com PR reads this docs branch.

Splits the README into pages that nuxt.com can host under
/modules/icon (getting started, guide, configuration).

Resolves #466

Amp-Thread-ID: https://ampcode.com/threads/T-01a1721c-4512-7150-9905-efce9f4b7f68
Co-authored-by: Sébastien Chopin <atinux@gmail.com>
@pkg-pr-new

pkg-pr-new Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
npm i https://pkg.pr.new/@nuxt/icon@554

commit: ad4c0dc

ampagent and others added 2 commits October 25, 2026 11:43
Agents and search read the page title; the sidebar keeps `Overview`
through `navigation.title`.

Amp-Thread-ID: https://ampcode.com/threads/T-01a1721c-4512-7150-9905-efce9f4b7f68
Co-authored-by: Sébastien Chopin <atinux@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create docs website

2 participants