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

Move functional concepts docs to Cargo docs #414

Open
tijlleenders opened this issue Nov 11, 2023 · 0 comments
Open

Move functional concepts docs to Cargo docs #414

tijlleenders opened this issue Nov 11, 2023 · 0 comments
Labels
clean code devex documentation Improvements or additions to documentation

Comments

@tijlleenders
Copy link
Owner

Is your feature request related to a problem? Please describe.
Documentation should be in one place to make it more maintainable and accurate.
For a Cargo crate, this place is the Rust cargo docs.

Describe the solution you'd like
Move all the concepts and definitions on documentation/functional/Concepts.md to Rust structs and corresponding cargo docs.

Describe alternatives you've considered
Copy-Paste. This is more work and error-prone.

Additional context
Need came up when making #409

@tijlleenders tijlleenders added documentation Improvements or additions to documentation devex clean code labels Nov 11, 2023
@tijlleenders tijlleenders moved this to Parking lot in ZinZen scheduler Nov 11, 2023
@tijlleenders tijlleenders moved this from Parking lot to Low prio in ZinZen scheduler Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean code devex documentation Improvements or additions to documentation
Projects
Status: Low prio
Development

No branches or pull requests

1 participant