Solan AI-Readable Reference
Crawler-friendly documentation entry points, guidance for generating Solan code, stable source links, and clear distinctions between documented and untested examples.
Machine entry points
Public machine-readable entry points
| Resource | Use |
|---|---|
| /llms.txt | Short index of documentation sections and canonical sources. |
| /llms-full.txt | Bilingual text bundle of the site learning guide, reference pages, and source files. |
| /sitemap.xml | Public indexable URLs, including documentation pages. |
| /robots.txt | Public crawl policy; documentation is allowed and /api/ is disallowed. |
| /solan-repository-index.json | JSON list of public repository files and links for the source snapshot. |
| GitHub | Original language source; when details conflict, inspect the linked file rather than assuming the bundle is newer. |
These endpoints make content readable and linkable; they do not guarantee that every AI provider will crawl or index it automatically.
Code generation
Recommended rules for Solan coding assistants
- Treat Solan as its own language; do not automatically translate it into Python/JavaScript English keywords when the lexer accepts Arabic forms.
- Verify a function name, signature, and receiver type in the relevant page or source file. A name in the method table is not available on every type.
- Start from examples identified as README-derived, then verify against the user’s version. Samples labeled “not executed” are not execution tests.
- Do not invent export rules or argument/return types where the file does not declare them. State what remains unknown.
- Do not duplicate install instructions; point to
/installand use/docs/clifor runtime commands. - For version-sensitive files, link a commit or inspect current GitHub and state when it was checked.
Usage prompt
Copyable instructions for an AI assistant
The Arabic and English prompts above intentionally require source verification and disclosure of uncertainty; they do not claim that any model has special access to the website.
Reference limits
Discovery does not mean automatic adoption
llms files and structured pages help crawlers and AI tools that visit the site, but they do not automatically add the site to model training data or guarantee inclusion in search/AI answers. Search Console ownership and Google indexing are managed in the site’s Google account, separately from publishing a Vercel sitemap.
Source files
Direct links pinned to the source snapshot used by this reference; the main branch may change later.