solutions: reference designs: Added CN0584 page and sub-pages

[jvelasc2]

Type

• Documentation
• Bug fix
• New feature
• Continuous integration

Checklist

• I have performed a self-review of changes
• I have followed the guidelines:
  • https://analogdevicesinc.github.io/documentation/contributing/docs_guidelines.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/index.html
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#documentation-structure
• I have used the appropriate roles and directives:
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/roles.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/directives.html
• I ensured that binary data was committed to git lfs:
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#adding-images-and-other-binary-files
• I have built the pages I edited or created, using either make html or adoc serve:
  • https://analogdevicesinc.github.io/doctools/cli.html#serve
• I have signed-off my commits and believe my contribution improves the repository.

[jvelasc2]

Hi @gastmaier ,
Kindly do not merge the CN0584 pages to main right away. I'd like Mark to see the contents first.
Thank you.

• Joyce

[gastmaier]

Just a nitpick for new screenshots/content, use png, jpg causes aberration around sharp edges.
Also, since we use lfs, prioritize high-res, big graphs, high quality. (if importing from wiki, ensure you saved the full size image, the one loaded into the wiki page is further compressed)

[thorenscientific]

@jvelasc2 I'm traveling this week, but will review as soon as I can. Thanks for putting this together!

[thorenscientific]

@jvelasc2 these should point to docs in https://analogdevicesinc.github.io/hdl/library/index.html
@gastmaier should we point directly to the URL for the core documentation, or is there a role? (Just thinking ahead if stuff moves around)

[thorenscientific]

@jvelasc2 I THINK this would be the new URL: https://analogdevicesinc.github.io/hdl/user_guide/ip_cores/axi_dac/index.html#dac-channel
@gastmaier does this make sense?

[thorenscientific]

@jvelasc2 , @gastmaier , a couple of other observations and questions:
Most of the wiki links have updated github docs equivalents. Is there a role for referring to docs hosted in other repos, like HDL in this case? I suppose it's more likely that stuff in the documentation repo itself will move around (reference designs, eval board docs, etc.) so absolute URLs to HDL documentation wouldn't be a problem, but what about the case where HDL docs move? (might not be a problem here, but thinking of future cases.)

There are a few zip files that may want to move somewhere else - python files that may be more appropriate in pyadi-iio, boot files that might be incorporated into Kuiper Linux or some other CI build process.

Most of the images look okay, but are probably not up to standard. Can we leave as-is for now, and work with the apps engineers to re-shoot as svg (or whatever makes the most sense)?

Lastly, the HDL project page is pretty redundant to https://analogdevicesinc.github.io/hdl/projects/cn0585/index.html. I'd say let's leave as-is for the moment, and work with the apps engineers on updating.

[jvelasc2]

Hi Mark @thorenscientific ,
Thank you very much for reviewing these documents. I will work on the URL cleanup and update this PR the soonest!

-- Joyce

[gastmaier]

Hi @jvelasc2 , the hdl project page is always at hdl repo:
https://analogdevicesinc.github.io/hdl/projects/cn0585/index.html

You can use the search to quick find pages across repos, like this search
https://analogdevicesinc.github.io/hdl/?q=cn0584&r=hdl%2Cno-OS

under hdl they also named it as cn0585 instead of cn0584 but it seems to be the same project since the cn0584 is listed as supported boards and the search finds it.

for now you don't have to do changes, since I am reviewing, just a heads up

[gastmaier]

Hi @thorenscientific

references, absolute links

References to other repos must use external references
e.g.

:external+hdl:ref:`cn0585`.

(the title is obtained from the ref)
No absolute links, always refs or external refs.
It is also imporant to remember that for each repo the refs are global, so this is ok

.. _eval-cn0584-ebz digital-template:

this is not

.. _digital-template:

Because a similar page under eval-cn0584-new will conflict with the already taken label.

There are a few zip files that may want to move somewhere else - python files that may be more appropriate in pyadi-iio, boot files that might be incorporated into Kuiper Linux or some other CI build process.

I agree, but for public they need to be under analog's sw-download.
Since this repo uses git lfs, I am ok with them here, but I do wish we organized the blobs better, the naming is all over the place.

Most of the images look okay, but are probably not up to standard. Can we leave as-is for now, and work with the apps engineers to re-shoot as svg (or whatever makes the most sense)?

Yes... totally agree... i hate ugly screenshots.

Lastly, the HDL project page is pretty redundant to https://analogdevicesinc.github.io/hdl/projects/cn0585/index.html. I'd say let's leave as-is for the moment, and work with the apps engineers on updating.

Yup, removed. If I deleted content not over cn05867, please, re-add, but under the hdl repo...

[jvelasc2]

Hi @thorenscientific

references, absolute links

References to other repos must use external references e.g.

:external+hdl:ref:`cn0585`.

(the title is obtained from the ref) No absolute links, always refs or external refs. It is also imporant to remember that for each repo the refs are global, so this is ok

.. _eval-cn0584-ebz digital-template:

this is not

.. _digital-template:

Because a similar page under eval-cn0584-new will conflict with the already taken label.

There are a few zip files that may want to move somewhere else - python files that may be more appropriate in pyadi-iio, boot files that might be incorporated into Kuiper Linux or some other CI build process.

I agree, but for public they need to be under analog's sw-download. Since this repo uses git lfs, I am ok with them here, but I do wish we organized the blobs better, the naming is all over the place.

Most of the images look okay, but are probably not up to standard. Can we leave as-is for now, and work with the apps engineers to re-shoot as svg (or whatever makes the most sense)?

Yes... totally agree... i hate ugly screenshots.

Lastly, the HDL project page is pretty redundant to https://analogdevicesinc.github.io/hdl/projects/cn0585/index.html. I'd say let's leave as-is for the moment, and work with the apps engineers on updating.

Yup, removed. If I deleted content not over cn05867, please, re-add, but under the hdl repo...

[jvelasc2]

Hi @gastmaier ,
I've checked the hdl page that you removed, it seems that everything is covered in the existing page in hdl repo.
Also, thank you for fixing the incorrect refs. I'll take note of the proper syntax.