Halaman ini diterjemahkan dari dokumentasi bahasa Inggris. Perintah, pengenal, dan contoh tidak diubah. Runtime 7.24.4 · SDK 2.6.7. Sumber bahasa Inggris

AX Wiki repositori

Status: Aktif
Cakupan: kondisi terkini
Terakhir ditinjau: 2026-10-03 Pemilik: runtime AX Code

AX Wiki adalah kompiler wiki repositori bawaan AX Code. Ia mengubah sumber terlacak, konfigurasi, uji, alur kerja, dan dokumentasi yang sudah ada menjadi basis pengetahuan Markdown kecil yang didukung sumber di bawah .ax-wiki/. Ia memakai konfigurasi penyedia dan perutean model yang sama dengan AX Code; tidak ada executable atau penyimpanan kredensial terpisah.

ax-code wiki viz menggambar halaman yang dikompilasi dan berkas yang mereka kutip. Tangkapan layar peta itu ada di Visualisasi bukti Wiki.

Di mana ia cocok

Prosa Wiki adalah lapisan navigasi yang dikompilasi, bukan bukti struktural. Jika wiki tidak sejalan dengan kode, percayai kode dan jalankan ax-code wiki update.

Mulai cepat

Sambungkan penyedia AX Code, lalu jalankan:

ax-code wiki plan
ax-code wiki generate
ax-code wiki doctor

ax-code init --wiki menghasilkan AGENTS.md, menyisipkan blok penunjuk AX Wiki, dan mengompilasi wiki dalam satu alur kerja. Pakai --wiki-only-agents untuk menambahkan penunjuk tanpa panggilan model.

Perintah

Opsi pembuatan mencakup --model provider/model, --dir <relative>, --quiet, --skip-agents, dan --force. --force sengaja diwajibkan untuk mengganti konten yang dihasilkan yang disunting manual di luar bagian terlindungi.

Direktori repositori

Sejak v7.22.2, direktori keluaran bawaan adalah .ax-wiki/. Awalan tersembunyi mengidentifikasi pengetahuan repositori yang dipelihara AX Code. Ia tidak membuat berkas diabaikan Git: pilih apakah akan meng-commit pengetahuan ini atau menambahkan /.ax-wiki/ ke .gitignore repositori Anda.

Pakai wiki.dir di ax-code.json atau --dir docs/knowledge untuk memilih direktori relatif lain; bendera CLI diutamakan. Semua pembuatan, status, penunjuk agen, pemeliharaan latar belakang, dan visualisasi memakai pilihan itu. Kompiler tidak secara otomatis mendeteksi, memindahkan, atau menggabungkan direktori ax-wiki/ yang lebih lama. Nama paket dan generator, ax-wiki.config.json, dan ax-wiki.instructions.md tidak berubah.

Kontrak yang dihasilkan

AX Wiki menulis halaman Markdown dan .ax-wiki/.manifest.json. Setiap halaman memiliki frontmatter yang berisi:

• generated_by: ax-wiki
• summary yang ringkas
• symbols persis yang dikembalikan dari pembuatan yang didukung bukti
• sources relatif repositori yang dipakai untuk mengompilasi halaman

Manifes menyimpan hash rencana deterministik, hash sumber repositori, hash halaman, model pembuatan, revisi git, dan waktu pembuatan. Halaman ditulis secara atomik; manifes ditulis terakhir dan hanya setelah kandidat dalam memori yang lengkap lulus validasi.

Penemuan sumber mengutamakan daftar berkas terlacak dan tidak diabaikan milik Git, mengecualikan direktori hasil/build/vendor dan wiki itu sendiri, melewati berkas biner atau yang terlalu besar, dan menolak jalur atau tautan simbolis di luar repositori.

Navigasi subsistem

Rencana bawaan mempertahankan halaman mulai cepat, arsitektur, dan pengembangan. Modul yang melebihi anggaran jumlah sumber atau bita bukti satu halaman juga dapat menerima halaman terfokus seperti modules/core/src/session.md. Halaman ini mencakup subdirektori langsung di bawah direktori src, lib, atau app modul, dengan setidaknya tiga berkas kode per subsistem dan dua subsistem yang memenuhi syarat dalam modul.

Halaman subsistem mencakup subpohon implementasinya dan berkas yang cocok di bawah direktori test atau tests modul. Instruksi pembuatannya meminta titik masuk, aliran runtime, batas, lokasi perubahan konkret, dan uji yang relevan. Halaman modul menempatkan hingga dua berkas uji segera setelah sumber berperingkat tertinggi agar uji dapat ikut serta dalam pemilihan bukti yang dibatasi.

Anggaran bawaan total tetap 12 halaman, termasuk tiga halaman ikhtisar. Ikhtisar modul dan halaman subsistem bersaing untuk slot tersisa menurut jumlah sumber; subsistem disertakan hanya setelah ikhtisar induknya. Subsistem yang lebih besar dapat menggeser halaman paket yang lebih kecil. Pratinjau hasilnya dengan ax-code wiki plan. Naikkan maxPages (hingga 40 untuk rencana otomatis), atau konfigurasikan pages eksplisit bila subsistem tertentu membutuhkan cakupan yang dijamin. Rencana eksplisit tetap otoritatif dan tidak menerima halaman subsistem otomatis.

Ini meningkatkan navigasi dan fokus bukti; ia tidak memverifikasi prosa yang dihasilkan atau menjamin bahwa agen membaca wiki. Ikuti kutipan kembali ke sumber saat ini sebelum mengandalkan detail implementasi.

Cara agen memakai wiki

Agen menjangkau wiki dengan tiga cara, dari yang termurah hingga yang paling spesifik:

1. Indeks prompt. Bila wiki yang sehat ada, prompt sesi membawa blok <repo_wiki> pendek: lokasi wiki, label kesegaran, dan satu baris per halaman (jalur dan ringkasan yang dipangkas, sekitar 750 token untuk 12 halaman bawaan). Ringkasan hanya menunjukkan di mana harus membaca; mereka bukan bukti.
2. Alat repo_wiki. Alat hanya-baca dengan tiga operasi: index (kartu halaman dengan kesegaran per halaman), read (satu halaman plus sumber yang dikutip, sumber dikutip mana yang berubah, dan simbol frontmatter apa pun yang tidak ditemukan di sumber itu), dan related (halaman untuk simbol, sebutan isi, atau jalur sumber). Ia tersedia di profil alat penuh dan pengodean dan memakai izin read.
3. Alat berkas generik. read, glob, dan grep pada .ax-wiki/ tetap berfungsi.

Kesegaran prompt dinilai per halaman: halaman segar selama setiap sumber yang dikutipnya masih cocok dengan hash manifes. Berkas yang ditambah atau disunting yang tidak dikutip halaman mana pun membiarkan label prompt fresh dan menambahkan catatan bahwa wiki belum mencakupnya. Sumber dikutip yang berubah menandai label stale dan prompt meminta agen memperlakukan wiki hanya sebagai navigasi. ax-code wiki status dan wiki lint mempertahankan putusan yang lebih ketat di seluruh repositori, di mana berkas memenuhi syarat apa pun yang ditambah, dihapus, atau disunting adalah basi.

Wiki tidak pernah menggantikan sumber: setiap hasil read mencantumkan berkas yang harus diverifikasi, dan jika halaman dan kode tidak sejalan, kode yang menang.

Pembaruan bertahap dan konten manual

wiki update membandingkan hash sumber saat ini dengan manifes dan memetakan perubahan melalui pemilih setiap halaman. Perubahan rencana membuat ulang semua halaman yang direncanakan; jika tidak, halaman yang tidak terkait tetap tidak tersentuh.

Prosa yang dihasilkan dimiliki kompiler. Taruh teks pemelihara yang tahan lama di dalam blok terlindungi:

<!-- AX-WIKI:PROTECTED:START deployment-warning -->

Production migrations require an operator-approved maintenance window.

<!-- AX-WIKI:PROTECTED:END -->

Isi terlindungi bertahan terhadap pembuatan ulang. AX Wiki menolak menimpa suntingan manual lain kecuali --force diberikan. Halaman yang dihasilkan dan usang dihapus hanya bila konten terkelolanya tidak berubah dan tidak berisi bagian terlindungi.

Konfigurasi

Konfigurasikan integrasi di ax-code.json proyek:

{
  "wiki": {
    "enabled": true,
    "auto": true,
    "dir": ".ax-wiki",
    "model": "openai/gpt-5-mini",
    "autoInjectAgents": true,
    "touchClaudeMd": true,
    "maxPages": 12,
    "generationConcurrency": 2,
    "maxSourcesPerPage": 80,
    "exclude": ["fixtures/**"]
  }
}

include, exclude, maxSourceBytes, dan maxPageSourceBytes mengendalikan penemuan bukti dan anggaran. instructions menambahkan panduan kompiler khusus proyek. Untuk rencana yang sepenuhnya dikurasi, konfigurasikan entri pages dengan path, title, purpose, dan selectors; rencana eksplisit harus mencakup quickstart.md.

generationConcurrency menerima 1 atau 2. Pembuatan cloud bawaan bawaan ke dua panggilan halaman bersamaan; mesin lokal dan penyedia CLI bawaan ke satu. Setel ke 1 bila penyedia mengantre atau membatasi permintaan yang tumpang tindih. Penjadwalan tidak membatalkan konten halaman yang ada. Paket yang dapat dipakai ulang tetap serial kecuali pengaturan ini diberikan.

Setiap halaman model mendapat paling banyak dua percobaan terklasifikasi yang berbagi batas 180 detik. Tautan Wiki relatif diperiksa terhadap rencana halaman sebelum halaman diterima; respons tautan rusak dapat memakai percobaan tersisa untuk memperbaiki halaman itu. Validasi akhir dan penjaga konten manual tetap berjalan sebelum penerbitan.

Build yang terputus mempertahankan hasil tervalidasi di .ax-wiki/.page-cache/ (atau direktori Wiki yang dikonfigurasi). Build berikutnya memakai ulang hasil yang cocok hanya setelah memeriksa bukti sumber saat ini, rencana, generator, model, dan konten sebelumnya. Pembuatan awal tetap tidak diterbitkan sampai kandidat lengkap lulus validasi. Penerbitan yang berhasil menghapus entri staging yang terpakai; wiki generate eksplisit berikutnya tetap membuat ulang semua halaman. Entri cache dibatasi dan dikunci izin; entri yang rusak atau tidak dapat diakses diabaikan.

.build-report.json membedakan halaman yang dihasilkan model dan yang di-cache dari halaman written, yang benar-benar diterbitkan. Larik pages opsionalnya mencatat percobaan setiap halaman, durasi, ukuran bita prompt/sumber, dan pemakaian token persis bila dipasok penyedia. Build yang gagal atau dibatalkan tidak melaporkan halaman yang diterbitkan.

Anda juga dapat menaruh panduan kompiler di ax-wiki.instructions.md dan konfigurasi mesin inti di ax-wiki.config.json. Pengaturan runtime AX Code yang eksplisit menimpa konfigurasi inti bila keduanya diberikan.

Pemeliharaan interaktif bawaan

Membuka proyek di TUI AX Code mengaktifkan pemeliharaan Wiki latar belakang secara bawaan. Setelah 30 detik proyek menganggur, artefak yang hilang dibuat dan artefak basi diperbarui secara bertahap. Sesi yang sibuk/mencoba ulang, pekerjaan antrean, dan draf yang tidak kosong diutamakan dan membatalkan pembuatan latar belakang. Izin baca/tulis agen saat ini berlaku; agen hanya-baca tidak membuat. Tidak ada berkas instruksi agen yang ditulis ulang oleh alur kerja latar belakang ini.

Pakai "wiki": { "auto": false } untuk menonaktifkan pemeliharaan latar belakang, atau enabled: false untuk menonaktifkan kompilasi dan injeksi prompt. auto bawaan true dan tidak menulis konfigurasi. Ia memakai model Wiki yang dikonfigurasi atau model bawaan AX Code, dengan batas pekerjaan 10 menit dan hingga tiga percobaan otomatis dengan backoff. Permintaan graf eksplisit atau perubahan sumber/konfigurasi mengizinkan percobaan lain. Jalankan tanpa interaksi dan CI tidak mengaktifkan penjadwal interaktif. Direktori non-Git membutuhkan permintaan eksplisit. Di proyek Git, pembuatan dan pemakaian Wiki memakai akar pohon kerja terdekat, jadi membuka AX Code di sebuah paket tidak membuat Wiki paket terpisah.

Bilah samping sesi dan /wiki-viz membuka halaman kemajuan lokal segera dan meminta pemeliharaan. Setelah cuplikan siap, halaman itu menampilkan hubungan halaman/sumber Wiki yang tercatat. Lihat Visualisasi Wiki.

Perutean agen

Bila wiki yang sehat ada dan wiki.enabled bukan false, prompt sesi menerima protokol <repo_wiki> yang ringkas. Ia menyuruh agen mulai dari mulai cepat, memuat hanya halaman yang relevan, memverifikasi klaim penting melalui berkas yang dikutip, dan memakai alat graf/LSP untuk pertanyaan struktural.

healthy menggambarkan keberadaan direktori wiki, indeks, dan manifes. Bidang terpisah freshness adalah fresh, stale, atau unknown. Status dan perutean sesi membandingkan hash sumber saat ini memakai pengaturan sertakan/kecualikan dan ukuran yang efektif, jadi suntingan, penambahan, dan penghapusan yang belum di-commit terdeteksi. Pemeriksaan tidak memakai ulang putusan segar yang di-cache; mereka memindai sumber yang memenuhi syarat dengan konkurensi baca yang dibatasi. Wiki yang hilang atau dinonaktifkan menghindari pemindaian sumber. Kesegaran adalah pemeriksaan sumber pada satu saat, bukan validasi setiap klaim atau halaman yang dihasilkan; pakai lint untuk validasi artefak.

Wiki yang basi atau belum terverifikasi tetap tersedia untuk navigasi, dengan instruksi eksplisit untuk memverifikasi sumber asli saat ini sebelum mengandalkan klaim implementasi. Kesalahan verifikasi menghasilkan unknown. wiki status keluar 0 bila tidak ada direktori wiki (wiki yang hilang adalah laporannya). Bila wiki ada, ia keluar tidak berhasil jika wiki tidak sehat atau kesegaran bukan fresh.

Bukti Wiki dibatasi: setiap sumber yang dipilih menyumbang paling banyak 32,000 bita pertamanya dalam anggaran halaman, dengan pemotongan ditandai untuk generator. GraphContext dapat menambahkan cuplikan terpilih, tetapi setiap cuplikan dibatasi 80 baris. Bantuan navigasi ini tidak menjamin pelestarian setiap fungsi yang berubah atau penjaga yang diperlukan; sediakan kode asli yang diperlukan secara terpisah untuk tinjauan yang dicakup.

Blok <!-- AX-WIKI:START --> terkelola di AGENTS.md membawa kebijakan perutean yang sama tanpa menyalin konten wiki ke instruksi repositori.

CI

Jalankan ax-code wiki update diikuti ax-code wiki lint dalam pekerjaan yang terautentikasi penyedia, lalu buka PR dokumentasi. Lihat examples/ax-wiki-update.yml. Perlakukan perubahan wiki yang dihasilkan seperti dokumentasi lain: tinjau kutipan sumber dan hindari penggabungan otomatis keluaran model.

Pemecahan masalah