Commit Graph

10 Commits (0d948816c316a681ad825758f82ff264738dfa66)

Author SHA1 Message Date
StancaPop c0ffdefe9d docs: Add adaq7980 documentation 2023-11-16 16:45:51 +02:00
Jorge Marques ed0f496d56
docs: flatten images paths, toctree and images guidelines (#1222)
Recommend storing images like any other artifact: in a hierarchical
manner, without "images" subfolders.
This is intended to avoid dangling artifacts when projects are moved,
renamed, or deleted.
Recommend overwriting the page title with a shorter title in the
toctree, so the navigation bar doesn't overflow or get too cluttered.
Add acostina to CODEOWNERS

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-15 12:13:26 -03:00
StancaPop 75c6560567 docs/ad7616: Remove duplicated info 2023-11-14 09:56:54 +02:00
Jorge Marques c66cc5e79a
docs: links, drop part, fixups, codeowners
Drop part role, use generic adi instead for root adi domain links.
For future reference, the snipped used was:
find ./docs/projects -type f -exec sed -i 's/:part:/:adi:/g' {} \;
Drop Containerfile.
Add option to validate links status (e.g. 200, 404), intended mostly for CI
use to check if a page has disappeared from the internet.
Validate links uses coroutines to launch multiple tasks concurrently,
but do it in bundles to avoid being rate limited.
Fixup regmap styling.
Add imoldovan, jmarques, spop, lbarbosa as docs codeowners.
Remove branch field for links to the hdl repo.
Change git role to display full path.
Fixup ZedBoard link label, remove IP List, add SYSID_ROM dokuwiki link
in ad716_sdz project.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-13 15:42:46 +00:00
StancaPop 0e0e1e4655 docs/projects/ad7616_sdz: Update block diagrams 2023-11-09 14:43:20 +02:00
Stanca Pop a09ee9d481 docs/projects/ad7616_sdz: Add ad7616_sdz project documentation 2023-11-02 14:50:42 +02:00
Iulia Moldovan f548c422b8 docs/projects/ad9783 & images: Add ad9783_ebz project doc
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan c301f4f44e docs/projects/ad9081 & images: Add ad9081_fmca_ebz project doc
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan 8eda123037 docs/projects/template & common: Create project doc template
* Created the template for the HDL project documentation
* Added the More information and Support pages as two separate files
  which will be embedded in the project documentations

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Jorge Marques cf056cf81c docs: add regmap directive
Automate table generation for register maps.
Based on tfcollins' vger python scripts.
There are docs/adi_regmap_*.txt with more than one regmap per file,
so the logic changed to allow that.
Using title tool as the unique identifier now.
It has a global option to set the default state (hidden or visible)
for the collpasible tables.
Also remove CSVs.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00