Generate llms.txt files on build for LLM reference

[josh-wong]

Description

This PR introduces a new plugin, docusaurus-plugin-llms, to the Docusaurus configuration and updates the package.json file to include the plugin as a dependency. The plugin is configured to generate the following files on build:

• llms.txt: Contains titles and links of the latest version of the docs.
• llms-full.txt: Contains content from the latest version of the docs.

These generated files adhere to the current format for LLMs.txt files.

Related issues and/or PRs

• Generate llms.txt files on build for LLM reference docs-scalardb#1404

Changes made

• Added docusaurus-plugin-llms to package.json: Included the plugin version ^0.1.5 as a dependency. (package.jsonR36)
• Added docusaurus-plugin-llms to docusaurus.config.js: Configured the plugin with options to generate llms.txt and llms-full.txt, specify the docs directory, and enable content cleaning features like removing duplicate headings and including unmatched last headings. Some options are noted to have issues that may require a plugin upgrade. (docusaurus.config.jsR177-R191)

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

• I have updated the side navigation as necessary.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation to reflect the changes.
• Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
• My changes generate no new warnings.
• Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

[gemini-code-assist]

Summary of Changes

Hello @josh-wong, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request integrates a new Docusaurus plugin to automatically generate llms.txt and llms-full.txt files during the build process. These files provide structured and comprehensive content from the documentation, making it readily available for Large Language Models (LLMs) to reference.

Highlights

• LLM Documentation Generation: This pull request introduces the docusaurus-plugin-llms to automatically generate llms.txt and llms-full.txt files during the Docusaurus build process. These files are designed to provide structured and comprehensive content from the documentation for Large Language Models (LLMs) to reference.
• Dependency and Configuration Update: The docusaurus-plugin-llms (version ^0.1.5) has been added as a new dependency in package.json and package-lock.json. The plugin is configured in docusaurus.config.js to specify generation options, the documentation directory (docs), and content cleaning settings, with notes indicating that some cleaning options might require a future plugin upgrade for full functionality.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces the docusaurus-plugin-llms to generate llms.txt files, which is a great addition for discoverability by LLMs. The implementation is straightforward.

My review focuses on improving the maintainability and clarity of the new plugin configuration in docusaurus.config.js. I've suggested removing duplicated configuration values and refining the comments for non-functional options to make the code cleaner and easier to manage in the long run. The changes in package.json and package-lock.json look correct.