leo icon indicating copy to clipboard operation
leo copied to clipboard

Published 20 hours ago • verified publisher icon AleoHQ

[Feature] Readme For Each Leo Package

Open gluax opened this issue 3 years ago • 3 comments

🚀 Feature

Each Leo sub-package should have a README of what the package is and how it works.

Motivation

Better documentation makes it easier for open-source people to contribute and for people to better understand the use-case of each package.

Todo

  • [ ] asg-passes
  • [ ] asg
  • [x] ast
  • [x] ast-passes
  • [ ] compiler
  • [x] errors
  • [ ] examples
  • [x] grammar
  • [ ] imports
  • [ ] input
  • [ ] leo
  • [ ] linter
  • [ ] package
  • [x] parser
  • [ ] state
  • [x] stdlib
  • [ ] synthesizer
  • [ ] test-framework
  • [x] tests

gluax avatar Jul 15 '21 17:07 gluax

@gluax we have README in tests: https://github.com/AleoHQ/leo/blob/master/tests/README.md. Can it be considered a README for test-framework as well?

damirka avatar Jul 19 '21 16:07 damirka

@damirka, we could probably still make a readme in test-framework that links to the tests one.

gluax avatar Jul 19 '21 17:07 gluax

Marking this issue as low priority until post-refactor for testnet2

collinc97 avatar Feb 16 '22 20:02 collinc97

This issue will be updated and marked as medium priority for 2023.

collinc97 avatar Jan 05 '23 18:01 collinc97