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

docs: intial implementation based on rustdoc and mermaid #966

Merged
merged 17 commits into from
Jun 29, 2024

Conversation

FlorianFranzen
Copy link
Collaborator

@FlorianFranzen FlorianFranzen commented Jun 27, 2024

Description

This adds the new documentation-only analog-docs crate to he repo and adds an extended flow documentation to the task pallet.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Code review prechecks:

  • [] Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Inline comments have been added for each method
  • I have made corresponding changes to the documentation
  • Code changes introduces no new problems or warnings
  • [ Test cases have been added
  • Dependent changes have been merged and published in downstream modules

@FlorianFranzen FlorianFranzen changed the title docs: intiali rustdoc docs: intial implementation based on rustdoc and mermaid Jun 27, 2024
@FlorianFranzen FlorianFranzen force-pushed the research/docs branch 5 times, most recently from 7447faf to 162d5d5 Compare June 29, 2024 12:36
@FlorianFranzen FlorianFranzen marked this pull request as ready for review June 29, 2024 12:36
@FlorianFranzen FlorianFranzen merged commit 7f035fc into development Jun 29, 2024
19 checks passed
@FlorianFranzen FlorianFranzen deleted the research/docs branch June 30, 2024 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants