Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Formalize user documentation #24

Open
7 tasks
charleskawczynski opened this issue Jan 27, 2025 · 2 comments
Open
7 tasks

Formalize user documentation #24

charleskawczynski opened this issue Jan 27, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@charleskawczynski
Copy link
Member

This package will likely soon become quite pervasive throughout our ecosystem, and we should have good documentation for:

  • What this package does
  • Usage
  • Benefits
  • Caveats
  • How it works
  • Background information
  • Motivation

I've added a bunch of documentation already in hopes to check off each of these boxes, but users will ultimately judge the quality of the documentation, and what pieces need improvement.

@charleskawczynski charleskawczynski added the documentation Improvements or additions to documentation label Jan 27, 2025
@charleskawczynski
Copy link
Member Author

Thoughts, @Sbozzolo?

@charleskawczynski
Copy link
Member Author

charleskawczynski commented Jan 27, 2025

@dennisYatunin suggested adding downsides:

  • Compile times
  • Inference?
  • Stack pressure (lines of code-typed / llvm / native, unique ssa slots)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant