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.

Sign up for GitHub

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

Jump to bottom

docs: Fixes and cleanup #1520

Merged
merged 10 commits into from
Nov 26, 2024
Merged

docs: Fixes and cleanup #1520

merged 10 commits into from
Nov 26, 2024

Conversation

IuliaCMoldovan
Copy link
Contributor

PR Description

  • Fixes and cleanup on all .rst files:
    • Remove trailing whitespaces
    • Fix lists indentation: instead of dash followed by 2-3 spaces ("- "), to be dash followed by one space ("- ")
    • Fix the way IPs doc. is referenced in the "HDL related" section:
      instead of
      :git-hdl:`library/axi_dmac <library/axi_dmac>`
      to be
      :git-hdl:`library/axi_dmac`
    • Fix the way ADI parts links are displayed (instead of :adi:`EVAL-AD3552R <EVAL-AD3552R>` to be :adi:`EVAL-AD3552R`)
    • Fix page title for some projects
    • Replace links with roles, where possible
    • Replace code-block directive with shell where needed
  • docs/user_guide/architecture: Add label to CPU interconnect section
  • docs/library: Uniformize the obsolete IP warning
  • docs/projects: Insert label to the Architecture/CPU interconnect section

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

@IuliaCMoldovan IuliaCMoldovan force-pushed the doc_fixes branch 3 times, most recently from c7e30bf to 2e53c64 Compare November 19, 2024 14:44
gastmaier
gastmaier requested changes Nov 22, 2024
View reviewed changes
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.

Super minor changes:
0001-Review-Update-shell-minor-misspelling.patch

Adding bash to shell is optional since is the default linter, but I added anyway.

And a suggestion about using Sphinx comment blocks for instructions on the template, since the code editor will generally color them differently, may be easier for the author using it to notice the instructions.
0002-Review-Use-comments-blocks-for-instructions.patch

docs/projects/ad57xx_ardz/index.rst Show resolved Hide resolved
docs/projects/ad7606x_fmc/index.rst Show resolved Hide resolved
@IuliaCMoldovan
docs/library: Uniformize the obsolete IP warning
429bbd3 
 * axi_ad9144
 * axi_ad9371
 * axi_ad9643
 * axi_ad9671

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/library: Fixes and cleanup
5a91f1c 
* Remove trailing whitespaces
* Fix lists indentation
* Replace links with roles where possible

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/user_guide: Fixes and cleanup
00a1cb0 
* Remove trailing whitespaces
* Fix lists indentation
* Replace links with roles where possible
* Replace code-block with shell directive where needed
* build_intel_boot_image:
  * Add links to the device trees of the respective projects
  * Fix lists indentation

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/user_guide/architecture: Add Intel section
cbd356a 
Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
Copy link
Contributor Author

Rebased onto latest main

@IuliaCMoldovan
Copy link
Contributor Author

Added changes from patches

@IuliaCMoldovan
docs/projects/template: Fixes and cleanup
afce7ef 
* Fix lists indentation and references
* Replace code-block with shell directive
* Add comments to better emphasize the text which should be kept

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/projects: Add ref. to CPU Intercon. Addr. & update section
03f9e41 
* user_guide/architecture: Create label for CPU intercon. section

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/projects: Fixes and cleanup
b6f0bb8 
On all project docs:

* Fix the way links are written
* Fix lists indentation
* Remove trailing whitespaces

Additionally:

* ad3552r_evb: Change the title according to the project name

* ad408x_fmc_evb: Add newline at end of file

* ad4110: Fix page title

* ad411x_ad717x:
  - Remove link to AD4170-4 as this is not part of this project
  - Fix links to boards, as they weren't ok for EVAL-AD7173/5

* ad4170_asdz:
  - Remove wrong link to EVAL-AD4170-ASDZ, as it doesn't exist yet
  - Add links to all supported devices

* ad4630_fmc: Add missing links to ADAQ4224
* ad5766_sdz: Add link to no-OS driver
* ad57xx_ardz: Add section for the block diagram
* ad5758_sdz: Add section for the block diagram
* ad7124_asdz: Fix links to evaluation boards, as they were pointing
  to the chips
* ad9213_evb: Add section for the block diagram
* ad9656_fmc: Fix wrong name in diagram
* adv7513: Add section for the block diagram
* cn0561: Fix evaluation board link
* cn0579: Add section for the block diagram

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/projects: Update references to IP doc.
7ed156e 
* ad4170_asdz: Fix typo in IP link
* ad469x_fmc: Fix typo in IP link
* ad5766_sdz: Fix typo in IP link
* ad738x_fmc: Fix typo in IP link

Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs/projects: Replace links with roles
89fffd4 
Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan
docs: Replaced code-block with shell directive where needed
7adbfb4 
Signed-off-by: Iulia Moldovan <[email protected]>
@IuliaCMoldovan IuliaCMoldovan merged commit 5b23567 into main Nov 26, 2024
2 of 3 checks passed
@IuliaCMoldovan IuliaCMoldovan deleted the doc_fixes branch November 26, 2024 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StancaPop StancaPop StancaPop approved these changes

@gastmaier gastmaier gastmaier approved these changes

@LBFFilho LBFFilho Awaiting requested review from LBFFilho LBFFilho is a code owner

Assignees
No one assigned
Labels
doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@IuliaCMoldovan @gastmaier @StancaPop