Lewati ke konten utama

Bekerja dengan AI

Dokumentasi Android Macro kini dapat dikonsumsi dengan cara yang lebih ramah LLM.

Hal ini memberi Anda tiga pola akses berbeda:

  1. Buka halaman dokumentasi apa pun sebagai markdown biasa dengan menambahkan .md
  2. Muat indeks dokumentasi terkurasi dari /llms.txt

Cermin Markdown​

Setiap rute dokumentasi kini memiliki cermin markdown.

Contoh:

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

Ini berguna ketika:

  • Anda ingin menempelkan halaman ke dalam LLM
  • Anda ingin agen mengambil versi dokumentasi yang bersih alih-alih mengurai HTML
  • Anda ingin teks yang stabil untuk konteks prompt

llms.txt​

Akar situs menyajikan indeks llms.txt:

https://androidmacro.com/llms.txt

File ini adalah peta dokumentasi terkurasi untuk penggunaan LLM. File ini mengarahkan model dan alat ke halaman terpenting lebih dulu, lalu menautkan ke versi markdown dari dokumentasi.

File terkait:

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

Gunakan seperti ini:

  • llms.txt untuk titik awal yang terkurasi
  • llms-full.txt saat Anda ingin satu ekspor besar dari korpus dokumentasi
  • llms-sitemap.txt saat Anda ingin daftar URL markdown yang ramah mesin

Mengapa Ini Membantu​

Dokumentasi HTML dirancang untuk manusia. LLM biasanya bekerja lebih baik dengan:

  • markdown alih-alih HTML halaman lengkap
  • indeks terkurasi alih-alih merangkak setiap rute secara buta

Itulah sebabnya penyiapan ini menggunakan keduanya:

  • cermin .md untuk akses halaman mentah
  • penemuan gaya llms.txt

Arsitektur Saat Ini​

Cermin markdown dan file llms.txt dibuat ke dalam keluaran static Docusaurus, sehingga diterapkan bersamaan dengan situs dokumentasi.

Catatan​

  • Halaman landing kategori juga mendapatkan cermin markdown, seperti https://androidmacro.com/docs/reference/storage.md
  • Markdown yang dibuat dirancang untuk konsumsi LLM, sehingga beberapa sematan interaktif diganti dengan catatan singkat
  • Bangun ulang situs dokumentasi setelah perubahan konten agar cermin markdown dan llms.txt tetap sinkron

Halaman Terkait​