Aller au contenu principal

Working with AI

Android Macro docs can now be consumed in a more LLM-friendly way.

This gives you three different access patterns:

  1. Open any docs page as plain markdown by appending .md
  2. Load the curated docs index from /llms.txt

Markdown Mirror​

Every docs route now has a markdown mirror.

Example:

  • HTML page: https://androidmacro.com/docs/basic/how-to-use
  • Markdown page: https://androidmacro.com/docs/basic/how-to-use.md

This is useful when:

  • you want to paste a page into an LLM
  • you want an agent to fetch the clean docs version instead of parsing HTML
  • you want stable text for prompt context

llms.txt​

The site root exposes an llms.txt index:

https://androidmacro.com/llms.txt

This file is a curated map of the docs for LLM use. It points models and tools toward the most important pages first, then links out to markdown versions of the docs.

Related files:

  • https://androidmacro.com/llms-full.txt
  • https://androidmacro.com/llms-sitemap.txt

Use them like this:

  • llms.txt for a curated starting point
  • llms-full.txt when you want one large export of the docs corpus
  • llms-sitemap.txt when you want a machine-friendly list of markdown URLs

Why This Helps​

HTML docs are designed for humans. LLMs usually do better with:

  • markdown instead of full page HTML
  • a curated index instead of crawling every route blindly

That is why this setup uses both:

  • .md mirrors for raw page access
  • llms.txt style discovery

Current Architecture​

The markdown mirrors and llms.txt files are generated into the Docusaurus static output, so they are deployed together with the docs site.

Notes​

  • Category landing pages also get markdown mirrors, such as https://androidmacro.com/docs/reference/storage.md
  • The generated markdown is designed for LLM consumption, so some interactive embeds are replaced with short notes
  • Rebuild the docs site after content changes so the markdown mirrors and llms.txt stay in sync