search

Seravo / docs

Documentation for Seravo.com customers and developers
https://seravo.com/docs/
15 stars 15 forks source link

Document the development #69

Closed Moppa5 closed 3 years ago

Moppa5 commented 3 years ago

Description Currently there is no clear documentation on how one can and should start developing this repository. There is no clear documentation on setupping the local development environment either. We should document what is the desired way to setup and start developing or testing the repository and its contents locally. For example, I had never developed our docs and the crucial setupping & testing command were provided in #68. If setupping and running is so easy that it only requires couple of commands, it should be quite trivial and documented as well.

@sjaks, Would you be interested in documenting the setup process or in general improving the documentation?

sjaks commented 3 years ago

Yes, I will take a look. The page generation in README.md also seems to be very outdated.

Some simple instructions for adding a new page and then running the local env should be written.

Moppa5 commented 3 years ago

@sjaks, Great! You can request review from me if you want as the documentation should be easy to understand, and I haven't been developing the docs.