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

chore(Documentation): Update documentation to use the ADI Harmonic theme #1257

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

glen-anderson
Copy link

Description

Closes #1149 and moves the needle a bit on #1148

Update the documentation to better follow ADI guidelines:

  • Update the doc theme to use the harmonic-mkdocs-theme theme
  • Break the monolithic USERGUIDE.md into smaller top-level markdown files
  • Remove the generated doxygen files from the repo since they're generated at build time
  • Remove doxygen build steps from .github/workflows/build-docs.yml since they're taken care of in Documentation/build.py
  • Refactor Documentation/build.py to be a bit easier to maintain
  • Add markdownlint config to catch inconsistencies. I recommend the VS Code plugin
  • Fix and normalized all the markdown to follow lint rules

Happy to take feedback on this and update/modify as necessary.

Testing

Best to start from a clean workspace but it should work regardless.

git clean -dfx
python -m venv venv
source venv/bin/activate # or venv\Scripts\activate on Windows
pip install -r Documentation/requirements.txt
python Documentation/build.py
mkdocs serve

image

image

Checklist Before Requesting Review

  • PR Title follows correct guidelines.
  • Description of changes and all other relevant information.
  • (Optional) Link any related GitHub issues using a keyword
  • (Optional) Provide info on any relevant functional testing/validation. For API changes or significant features, this is not optional.

@glen-anderson glen-anderson added the documentation Improvements or additions to documentation label Nov 6, 2024
@glen-anderson glen-anderson self-assigned this Nov 6, 2024
@github-actions github-actions bot added BLE Related to Bluetooth Workflow Related to Workflow development labels Nov 6, 2024
Copy link
Contributor

@sihyung-maxim sihyung-maxim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - definitely nice to see the user guide partitioned out which makes it easier to navigate.

Double-check me on the "???+ ..." formatting though.

Comment on lines +7 to +8
???+ note "ℹ️ **Note**"
The first task when opening or creating any project is to ensure the BSP is set correctly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be the way GitHub displays markdown files in the PR reviews, but it looks off. Good idea to double check me:
image

And in VS code preview:
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your thoughts on removing these files, @lorne-maxim?

It helps with navigation and provides some other information if users prefer going through this route, but the files are outdated. If we keep these, then they need to be updated as well - though I'm not sure what resources are available for this.

@@ -0,0 +1,390 @@
# Getting Started

The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The typical **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typical **development** cycle typically sounds redundant.


## Supported Operating Systems

* Windows (Windows 10 only)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MSDK works on Windows 11 as well now.

site_author: Analog Devices
copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.'
site_author: Analog Devices, Inc.
copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The This software is proprietary to Analog Devices, Inc. and its licensors. line can be deleted. This line should have also been removed from most other files within the MSDK due to the permissive licensing of the MSDK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BLE Related to Bluetooth documentation Improvements or additions to documentation Workflow Related to Workflow development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MSDK User Guide: Move and divide userguide.md
3 participants