Documentation entry point for AI tools¶
Give a documentation index URL to an AI tool that can read web pages. Ask it to find and read the relevant pages before answering questions about NebulaGraph Database Developer Edition.
1. Choose a documentation version and entry point¶
Use a versioned URL to keep the tool on a specific documentation version. The examples below use v5.3.2. Replace the version in the URLs when using another version.
| Entry point | Purpose |
|---|---|
| llms.txt | Index of the main sections and a link to the full directory. Use it to explore the documentation scope. |
| llms-index.txt | Full page directory with titles, descriptions, and HTML and Markdown URLs. Use it to find specific syntax, configuration, or tutorials. |
To use the site's default version, provide the default llms.txt. This entry point changes when the site's default documentation version changes.
2. Ask an AI tool a question¶
For a specific question, give the tool the full directory URL and your question. Copy this example and replace the documentation version, product version or image tag, and question with your information:
Documentation version: v5.3.2
Documentation directory: https://dev-docs.nebula-graph.io/v5.3.2/llms-index.txt
Product version or image tag: <actual version or image tag>
Question: <your question>
Find and read the relevant pages before answering.
For commands or code, check options and version applicability.
Cite the URLs and sections of the pages you actually read.
Remove passwords, tokens, and business data before sharing configuration or error details.
3. Get individual page content¶
Each page in the full directory has both an HTML URL and a Markdown URL. For the v5.3.2 Python SDK tutorial:
- HTML documentation: Read the formatted page in a browser and navigate to sections.
- Markdown content: Read the same version's explanations, product names, and code examples as plain text that AI tools can access directly.
The AI tool cannot open a URL
Open the relevant page's Markdown URL in a browser and paste the content into the tool. You can also save it as a .md file and upload it to a tool that supports file uploads.