Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put all documentation on a single page #1691

Open
2 of 4 tasks
zoellner opened this issue Oct 14, 2024 · 1 comment
Open
2 of 4 tasks

Put all documentation on a single page #1691

zoellner opened this issue Oct 14, 2024 · 1 comment

Comments

@zoellner
Copy link

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

  • Would you be willing to help implement this feature?
  • Could this feature be implemented as a module?

Final checks

@maliksvd
Copy link

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

@danielroe danielroe transferred this issue from nuxt/nuxt Oct 24, 2024
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

No branches or pull requests

2 participants