#9 Consolidate documentation and add step-by-step

Zamknięty
otworzone 8 lat temu przez DeletedUser · 2 komentarzy
Deleted User skomentował 8 lat temu

I noticed that we now have the schedule formatting information both on this notabug site and in the README in the repo. I think it would be good to pick one place and put it all there, and I would probably vote for this site. Then just delete the documentation info from the README and replace it with the URL of the online documentation.

It would also be good to add an intro paragraph to the top of the documentation that outlines all the steps you need to build the schedule, like 1) Install the program, 2) Make the schedule and bios in the format below 3) Build the bios 4) Build the schedule

Then build out the steps in more detail below. And also explain prominently at the top what happens if you do a schedule with a bios page, etc.

I noticed that we now have the schedule formatting information both on this notabug site and in the README in the repo. I think it would be good to pick one place and put it all there, and I would probably vote for this site. Then just delete the documentation info from the README and replace it with the URL of the online documentation. It would also be good to add an intro paragraph to the top of the documentation that outlines all the steps you need to build the schedule, like 1) Install the program, 2) Make the schedule and bios in the format below 3) Build the bios 4) Build the schedule Then build out the steps in more detail below. And also explain prominently at the top what happens if you do a schedule with a bios page, etc.
siddharth ravikumar skomentował 8 lat temu
Właściciel

At the moment, all the documentation is in one place -- the README.rst file.

The main content at https://pypi.python.org/pypi/lpschedule-generator is the HTML version of the README.rst file.

At the moment, all the documentation is in one place -- the README.rst file. The main content at https://pypi.python.org/pypi/lpschedule-generator is the HTML version of the README.rst file.
siddharth ravikumar skomentował 8 lat temu
Właściciel

I've re-organized the documentation into sections.

It is here: https://pythonhosted.org/lpschedule-generator

I've re-organized the documentation into sections. It is here: https://pythonhosted.org/lpschedule-generator
Zaloguj się, aby dołączyć do tej rozmowy.
Brak etykiety
bug
Brak kamienia milowego
Brak przypisania
2 uczestników
Ładowanie...
Anuluj
Zapisz
Nie ma jeszcze treści.