Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Missing bits from docs #33

Open
8 tasks
oscarbenjamin opened this issue Feb 28, 2023 · 2 comments
Open
8 tasks

Missing bits from docs #33

oscarbenjamin opened this issue Feb 28, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@oscarbenjamin
Copy link
Owner

oscarbenjamin commented Feb 28, 2023 •
edited
Loading

Folllowing comments in gh-32.

The following sections need adding or filling out in docs:

  • README
  • Frontpage: features and requirements.
  • Usage section.
  • Dev section in docs
  • Overview of core types showing relation between classes.
  • Also add an overview of simplecas and explain what its purpose is.
  • TreeExpr.children replace dummy docstring.
  • ForwardGraph add a good docstring with diagrams.

(Feel free to edit/add to the list)
@oscarbenjamin oscarbenjamin added the documentation Improvements or additions to documentation label Feb 28, 2023
@oscarbenjamin oscarbenjamin mentioned this issue Feb 28, 2023
Merged
@asmeurer
Copy link

The main thing we need right now is to fill out the docs main page / project README to explain what the project is and what the plans for it are.

@samithkavishke
Copy link
Contributor

I would like to help on this, can you share some reference materials if possible or guidance to understand the repository.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@asmeurer @oscarbenjamin @samithkavishke