Write new documentation - Githubissues

chaseruskin / legoHDL

An experimental package manager and development tool for Hardware Description Languages (HDL).

https://c-rus.github.io/legoHDL

MIT License

14 stars 2 forks source link

Write new documentation #47

Closed chaseruskin closed 2 years ago

chaseruskin commented 2 years ago

A lot of changes have occurred since the last edition of documentation was written, previously found on an older website before mdbook. Now that lots of features are more stable and the project has a clearer vision and direction, documentation needs to be added.

Follows the documentation system outlined here.

Preliminary idea about the major sections to write:

[x] Getting started: installing and first steps
[ ] Tutorials: step-by-step lessons
[ ] How-to guide: general procedures for common scenarios
[ ] Topic guide: in-depth information and explanation about particular concepts
[ ] Reference: technical information
[ ] Commands: provides manual for commands

chaseruskin commented 2 years ago

This issue is being closed and broken into parts found in the new project called Documentation