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

treewide: Update docs and tutorial #196

Merged
merged 1 commit into from
Oct 2, 2024
Merged

treewide: Update docs and tutorial #196

merged 1 commit into from
Oct 2, 2024

Conversation

colluca
Copy link
Collaborator

@colluca colluca commented Oct 2, 2024

Contributions:

  • Update publications
    • Add links
    • Align with IEEE Xplore citation style
    • Reuse publications snippet from README.md in docs
  • Fix several cross-references
  • Move IP documentation sources to top-level doc folder and add unmaintained warning
  • Organize sources in docs/rm/ under a hw and sw subdirectory
  • After extensive search for a good JSON schema documentation generator (nothing better than adobe/jsonschema2md was found, and this is also not great), drop JSON schema docs altogether
  • Add advanced "Code Optimization" tutorial
  • Move base tutorial from target/snitch_cluster/README.md to documentation pages (allows us to use MkDocs admonitions which are not a standard Markdown feature)
  • Largely update base tutorial
  • Display copy button in all code blocks
  • Explicitly exclude sources which are not included in navigation tree (removes known info message)
  • Change default AXPY parameters for better trace visualization in tutorial and add ROI specification
  • Move schemas from docs to util/clustergen folder

Addresses:

@colluca colluca marked this pull request as ready for review October 2, 2024 17:48
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.

1 participant