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

Need improved documentation #23

Open
mikeingold opened this issue Mar 3, 2024 · 4 comments · Fixed by #122
Open

Need improved documentation #23

mikeingold opened this issue Mar 3, 2024 · 4 comments · Fixed by #122
Labels
documentation Improvements or additions to documentation

Comments

@mikeingold
Copy link
Collaborator

This example code and the resultant benchmarks were run circa v0.9.0 and need to be updated. There's probably no need to include benchmark results here any more, but a demo with a more interesting geometry would be nice.

@mikeingold mikeingold added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Mar 3, 2024
@mikeingold mikeingold changed the title TODO Update README Example Usage section Need to update example usage section on README Apr 14, 2024
@mikeingold mikeingold pinned this issue Aug 30, 2024
@mikeingold mikeingold changed the title Need to update example usage section on README Need improved documentation Sep 1, 2024
@mikeingold
Copy link
Collaborator Author

mikeingold commented Sep 1, 2024

TODO

README

  • Create a logo and add it on top
  • Write a new package description
  • Create an updated demo usage example

Documenter pages

  • Implement a Documenter system (Implement Documenter documentation pages #58)
  • Include a basic description of how differential forms is used
  • Add Example Usage page (leave a basic demo on README)
  • Move Support Matrix section from README
  • Complete triangle derivation (barycentric to rectangular/Euclidean domain transformation)

@mikeingold
Copy link
Collaborator Author

The README was overhauled in #70

@mikeingold
Copy link
Collaborator Author

Triangle solver documented in #71

@mikeingold mikeingold removed the good first issue Good for newcomers label Oct 11, 2024
@mikeingold mikeingold unpinned this issue Oct 25, 2024
@mikeingold mikeingold pinned this issue Oct 25, 2024
@mikeingold mikeingold unpinned this issue Nov 8, 2024
@JoshuaLampert JoshuaLampert reopened this Dec 2, 2024
@JoshuaLampert
Copy link
Member

In my opinion at least the "Example Usage" page needs an update. It would be nice if it is an @example, which runs and prints the output. And as you noted above:

This example code and the resultant benchmarks were run circa v0.9.0 and need to be updated. There's probably no need to include benchmark results here any more, but a demo with a more interesting geometry would be nice.

This is still true.

@mikeingold mikeingold pinned this issue Dec 27, 2024
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
2 participants