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

Add Evaluation Board template + EVAL-AD4052-ARDZ #10

Merged
merged 8 commits into from
Jan 22, 2025

Conversation

gastmaier
Copy link
Contributor

@gastmaier gastmaier commented Dec 18, 2024

Adds the evaluation board EVAL-AD4052-ARDZ user guide and template built from it.
Also:

  • Use toctree glob for evals
  • Minor fixess
  • Organize eval in category folders
  • Move adrv9026 to transceiver folder

The reasoning for this structure is that it allows to generate custom user guides, like this:

output.pdf

Evaluation Boards structure

At worst/most-complicated case, the structure is:

  • Overview
  • User Guide
  • Developer Overview
  • Developer Guide
  • Help and Support

With "User Guide" and "Developer Guide" containing multiples "plug&play" and technical guides, respectively.
Simpler evals, such as the pdf attached, may simplify the structure as needed.

Following the spirit of custom user guides,
here is a Contributing User Guide

from the following YAML:

project: "Documentation User Guide"
description: "How to contribute to the documentation repository"

include:
  - documentation/contributing


entry-point:
  - caption:
    files:
      - documentation/contributing

config:
  documentation:
    branch: "ad4052-template-eval"

then adoc custom-doc --builder pdf

@gastmaier
Copy link
Contributor Author

gastmaier commented Jan 22, 2025

Merging this to provide as an example, even though the content is shallow.

@gastmaier gastmaier merged commit 350d4d9 into main Jan 22, 2025
2 checks passed
@gastmaier gastmaier deleted the ad4052-template-eval branch January 23, 2025 12:32
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.

1 participant