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: add docs/library/cn0363/* specific IPs #1550

Merged
merged 1 commit into from
Feb 19, 2025
Merged

docs: add docs/library/cn0363/* specific IPs #1550

merged 1 commit into from
Feb 19, 2025

Conversation

caosjr
Copy link
Contributor

@caosjr caosjr commented Jan 2, 2025

PR Description

Adds documentation for the CN0363 specific IPs:

  • CN0363 DMA Sequencer;
  • CN0363 Phase Data Sync.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have compiled all hdl projects and libraries affected by this PR
  • I have tested in hardware affected projects, at least on relevant boards
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Critical Warnings on compilation
  • I have added new hdl testbenches or updated existing ones

Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick review done using the GitHub GUI

Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional review now using the proper tools...

Please do not commit trailing whitespace.
I sent patches privately to help applying the requested changes.

@gastmaier
Copy link
Contributor

output.pdf
Example unified doc after patches

Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The page does not fully follow the template https://github.com/analogdevicesinc/hdl/blob/main/docs/library/template_ip/index.rst?plain=1 .
It is important to follow the template, one handy trick of the doc is to cycle the pages anchored on a particular section using Ctrl+Alt+Shift+Left/Right so we can "batch" check on particular section.

IuliaCMoldovan
IuliaCMoldovan previously approved these changes Jan 28, 2025
@IuliaCMoldovan
Copy link
Contributor

Actually, I forgot about this, you should replace here the links as well, to point to this new documentation and not the one from wiki: https://github.com/analogdevicesinc/hdl/blob/main/docs/projects/cn0363/index.rst?plain=1#L243-L246

Adds documentation for the CN0363 specific IPs:
- CN0363 DMA Sequencer;
- CN0363 Phase Data Sync.

Signed-off-by: Carlos Souza <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
@caosjr caosjr merged commit e2f45ef into main Feb 19, 2025
2 of 3 checks passed
@caosjr caosjr deleted the doc_cn0363 branch February 19, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants