Iga dokumentatsioonitööriist suudab artikli majutada. Ükski ei tea, millal liidetud PR selle just valeks muutis. Ellie Docs ühendub sinu GitHubi hoidlaga, jälgib koodi, millest iga artikkel tegelikult sõltub, ning märgib ja koostab parandi mustandi hetkel, kui artikkel aegub.
Kaardita · Registreeru Google'i, Microsofti, GitHubi või e-postiga
API-s nimetatakse väli ümber. Lõpp-punkt tunnistatakse aegunuks. Kasutajaliidese voog kujundatakse ümber. PR liidetakse puhtalt, testid läbivad, ja vana käitumist kirjeldav abiartikkel jääb seisma: õige väljanägemisega, aga vaikselt vale, kuni klient või tugipilet selle välja toob.
Iga artikli saab siduda koodi, lõpp-punktide või API spetsifikatsiooniga, mida see tegelikult dokumenteerib, nii et Ellie Docs teab täpselt, mida jälgida.
GitHubi rakendus jälgib liidetud PR-e, hindab, kas need mõjutavad seotud artiklit, ja märgib selle. Ülevaatamiseks on kohe valmis parandatud mustand, mitte lihtsalt punane riba.
On sul OpenAPI spetsifikatsioon? Ellie hoiab viite sellega sünkroonis ja võrdleb iga versiooni puhul katkestavate muudatuste leidmiseks. Spetsifikatsiooni pole? Ta tuletab selle sinu marsruutidest ja päringuvalideerijatest ning viitab iga välja taga olevale koodile.
Paigalda Ellie Docsi GitHubi rakendus hoidlatesse, millest sinu tootedokumentatsioon sõltub. Me ei säilita sinu hoidla koopiat: kood tuuakse kätte siis, kui Ellie'l on seda vaja lugeda, ja hiljem tuuakse uuesti commit'i järgi.
Too olemasolev dokumentatsioon sisse veebilehe läbikäimise (crawl) abil või alusta nullist. Ellie Docs koostab artiklite mustandid ja seob igaühe koodi, lõpp-punktide või spetsifikatsiooniga, millest see sõltub.
Kui liitmine mõjutab seotud artiklit, märgib Ellie selle ja koostab parandi mustandi. Sinu tiim vaatab üle pakutud parandite järjekorra, selle asemel et otsida, mis katki läks.
GitHubi rakendus, mille ulatus on piiratud sinu valitud hoidlatega. Me ei säilita sinu hoidla koopiat: Ellie toob puu kätte siis, kui tal on seda vaja lugeda, ja hiljem tuuakse uuesti commit'i järgi. Alles jääb tuletatud materjal, millel artikkel seisab: iga väite taga olevad väljavõtted ja viited, et iga sinu dokumentatsiooni väite saaks jälgida selle õigustava koodini. Failidest leitud saladused peidetakse enne salvestamist ja sinu koodi ei kasutata kunagi mudelite treenimiseks.
Jah, see ongi eesmärk. Ellie Docs majutab ja renderdab avaliku abikeskuse ise, sealhulgas oma domeenid, nii et sa ei pea kahte süsteemi paralleelselt käitama.
Jah. Suuna Ellie Docs spetsifikatsioonile ja ta hoiab viidet selle põhjal ajakohasena, võrreldes iga uue versiooniga, kui sinu API areneb. Ilma selleta tuletab Ellie spetsifikatsiooni sinu koodist: lõpp-punktid ruuterist, väljatüübid päringuvalideerijatest ja kõige jaoks, mida kood otsesõnu ei ütle, uurimise, mis peab viitama ridadele, millest iga välja tuletas. Tuletatud lõpp-punktid jäävad privaatseks, kuni need üle vaatad, nii et sisemised marsruudid ei lekiks sinu avalikku viitesse.
Kasuta Ellie Docsi koos Ellie Desk'iga (varajane ligipääs): lahendatud tugipiletitest saab ühe klõpsuga uus dokumendiartikkel ja Desk'i tehisintellekti mustandid hakkavad automaatselt põhinema sinu avaldatud dokumentatsioonil.
Tasuta plaan, edasi alates $65 kuus aastase arvega. Vaata hindu →
