nuxt / nuxt.com

The Nuxt website, made with Nuxt.
https://nuxt.com
MIT License
311 stars 162 forks source link

Put all documentation on a single page #1691

Open zoellner opened 1 month ago

zoellner commented 1 month ago

Describe the feature

I noticed that using LLM coding agents doesn't work very well with Nuxt v3 since it is slightly too new to be baked in and examples are still rare.

It would help a ton if all of the documentation would be available on one single page which could then be fed to the LLM. Ideally without any fancy js etc to load additional content.

The request would therefore be to compile an extra page into the documentation that includes all the content in a single page.

Additional information

Final checks

maliksvd commented 1 month ago

I quickly accomplished this using a few terminal commands. The Nuxt documentation, available in Markdown format on nuxt/docs, can be combined into a single file.

To do this, list all the Markdown files in the docs directory by running the command: find . -name "*.md"

And then concatenate them into one file named complete-nuxt-docs.md by using cat $(find . -name "*.md") > complete-nuxt-docs.md.

If you want, you can find my complete file here https://github.com/maliksvd/nuxt-one-pager-for-llm/blob/main/complete-nuxt-docs.md