dsmrreader
Simplify documentation
Feature
Overwegen om alle documentatie naar Github te verplaatsen, zodat alles op 1 plek staat.
- Voordeel is ook dat er hier issues en discussies (en ook polls) gedaan kunnen worden.
- Verder geen vertalingen meer ondersteund, wat de drempel om docs bij te werken (of uit te breiden) aanzienlijk verlaagt.
Ik heb al kort gekeken wat de gevolgen zijn. Het grootste nadeel is:
- Geen vertalingen meer, maar opzich is Engels als voertaal voor documentatie prima
- Mogelijk geen meerdere versies meer. Niet perse een probleem, maar soms wat het handig om v4-installaties te verwijzen naar een v4-variant van een stukje documentatie.
- Geen zoekmachine index, al kan ik op readthedocs natuurlijk wel verwijzen.
- Staat los van de code, dus handmatig in sync
Wellicht beginnen met een opzet van een deel van de Engelse docs. Kan gewoon naast bestaande docs en ook net zo makkelijk weer geannuleerd worden als het toch niet zo werkbaar blijkt.
Oh blijkbaar ondersteunt het ook restructured format, wat ik nu gebruik voor readthedocs, maar eigenlijk wil ik daar vanaf. Vind het een vreselijk format.
Blijkbaar zit er een aparte repo achter: https://github.com/dsmrreader/dsmr-reader.wiki.git
Ik laat deze zo. Zolang RTD de hosting blijft doen, kan ik ermee leven dat het los staat van Github.