Instant Docs

Getting started

InstantDocs to eksperymentalny projekt dokumentacji programistycznej bezpośrednio powiązanej z danym fragmentem kodu. Może być wykorzystywany z dowolnym repozytorium Git dostępnym przez SSH.
  1. Dodaj do repozytorium klucz publiczny:
    ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDdOzh+wQTwt3xZ5E/kGZ7ua/c/bDnQUqxev5Bvst/0bpDkncr7rpHHtyK577rXL+ei1yZLFH1xzJRPPiN9kHwpj+bv3JbkpO8t1fszK57jHfQuZAP42t67iYCDHg7XGFZcprKIaQG8FUANMMW6aWA5KEZ11rq+H/vnJfUDtJVbERCaG5YysllWCwA+iRhN3LYwaq/ZiXUtrXQ1HMkKtpYr/VixdMeUaeSWmsA+Pa/9F1cjR4CnOyG6vx5e3dcmceD7JeezkE3esuiKWkZq20KzLKvyTF47lDKiEI7ps2pPF10zkUB1ZpZ8rXHREhj6tEvA0R0yx4t7FXHgf7tvrO27P8BdWfkA1PvAegwS59fE4GUbmG2+TF+ehyA/BfYr4+MYC4hSGkOCy9ln7SZLLIjeJxoIEc05UZcT+GAtNXuQVfvCFqPCwWPGlmrwwcwDUSyfJ+WCz7y8V8BLsxn7/lkfklWHvtUThsvUwoj9k9T/UPldy47gDVVNgSEs2e9uWOP4FNuf0Npzh/7aiqIDNvaG0/3YpGK+Ph9CPMSe3syYWZEa2C0UQc0rgq4Z2bZ4DqJvhqSvIy4wz/fnQbvPCCBvZE79QBgTf7khhYPY1YaJD1iBIbHif+eALKrsMGlZL50akteIWhnFR8TAgy0WKK39fp0J8dX7lZcwKtqEKxQimQ== server
    
  2. Wybierz nazwę dla repozytorium w ramach InstantDocs. Przejdź na URL http://id.krzysztofsikorski.pl//create_url/
  3. Instant docs automatycznie zaimportuje repozytorium i katalogi docs i tests napisane zgodnie ze standardem Markdownowym i behatowym. Na powyższym URLu zwróci Ci token - zapisz go gdzieś.
  4. Pod adresem http://id.krzysztofsikorski.pl//tree/?token= znajdziesz ładnie wyświetlony plik README.md z repozytorium. Od niego możesz zacząć przeszukiwanie dokumentacji!
  5. Zainstaluj rozszerzenie do swojego edytora tekstu. Jeśli nie ma takiego rozszerzenia, pod tym linkiem Znajdziesz plik wykonywalny, który po wykonaniu: ./instantdocs.sh nazwa_pliku znajdzie w dokumentacji dany plik. Oczywiście należy w nim uzupełnić nazwę repozytorium i token.
  6. W dokumnetacji umieszczaj znaczniki {#AppServiceProvider.php}, odpowiadające nazwie pliku. Dzięki temu łatwo narzedzie znajdzie plik odpowiedzialny za dany plik.