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

Added Apps and Solutions category with initial pages #7

Merged
merged 2 commits into from
Dec 18, 2024

Conversation

jvelasc25
Copy link
Contributor

migrated documentation for BMS solutions from Wiki

jvelasc2 and others added 2 commits December 15, 2024 17:19
@gastmaier
Copy link
Contributor

Hi Joyce!

I took a look on your PR, a made a review commit at 3107d79
Since the current branch has a merge conflict, I first rebased onto main, being your commit rebased d71a2f4 .

Here is what I changed:

  • Trailing white-space
  • Use :download: role for download links, to ensure these files are copied over during the doc build.
  • Use :adi: role for analog.com links
  • Use :dokuwiki: for wiki.analog.com links
  • For images with captions replace with figure:: :caption: {Caption}
  • Added a "bold-first-column", "bold-header" to table styling, and use that for the ad-cellpackbm-sl specifications table.
  • Changed the nesting of the EVB user guides to:
    • Overview: most content on the page
    • Guides&Samples Software: For other pages
    • Help and Support: Footer section.

Attached is ad-cellpackbm as a PDF to give a better idea on the resulting table of contents:
output-ad-cellpackbm-sl.pdf

The PDF is generated with the following YAML

# Custom doc builder template
# ---------------------------
# Generated with adi_doctools 0.3.51

#project: "AD-BMSE2E3W-SL"
project: "AD-CELLPACKBM-SL"
description: "Quick Start Guide"

# Dirs and files to include
# First level is repository name
include:
  #- documentation/solutions/reference-designs/ad-bmse2e3w-sl
  - documentation/solutions/reference-designs/ad-cellpackbm-sl

# Create toctree for entry point page
# Pages without a explicit entry point will be searched and globed
# until the root of the source doc is reached, which may include
# undesired additional pages/sections.
entry-point:
  - caption:
    files:
      #- documentation/solutions/reference-designs/ad-bmse2e3w-sl/index.rst
      - documentation/solutions/reference-designs/ad-cellpackbm-sl/index.rst

@thorenscientific
Copy link
Contributor

Hi Jorge,
I built this locally and it looks great. I suspect we'll end up rearranging things in time; the "Apps and Solutions" category may end up with a new name and / or home. As long as we're good with that, then merging this will help the conversation along.
Also, this might be a good home for some of the CftL user guides, a lot of the older ones are quite similar in structure, with a separate software user guide.

@gastmaier
Copy link
Contributor

gastmaier commented Dec 18, 2024

I'm taking the freedom to force push and merge with the review commit then.
Of course we can still move things around later.
One thing I noticed it that in the toctrees is much better to use :glob: since most of the merge conflicts are just adding more files to the toctree that could be simply */index to auto add them.

Side note:
Since this is a fork, I pushed with
git push joyce 3107d79d4faba3f14708e35e5618fb9247474575:migration --no-verify -f
To skip LFS upload to the fork, instead, I did git lfs push --all public after

@gastmaier gastmaier merged commit 33c6695 into analogdevicesinc:main Dec 18, 2024
gastmaier pushed a commit that referenced this pull request Dec 18, 2024
Added Apps and Solutions category with initial pages

Signed-off-by: Joyce Velasco <joyce.velasco@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
@jvelasc25
Copy link
Contributor Author

Hi Jorge and Mark,
Thank you for reviewing my PR and making the necessary adjustments. I'll take note of all changes, so I can apply them to my future documents/commits.

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.

4 participants