-
Notifications
You must be signed in to change notification settings - Fork 84
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
base: main
Are you sure you want to change the base?
chore(Documentation): Update documentation to use the ADI Harmonic theme #1257
Conversation
…ain doc index page
There was a problem hiding this 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.
???+ note "ℹ️ **Note**" | ||
The first task when opening or creating any project is to ensure the BSP is set correctly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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.' |
There was a problem hiding this comment.
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.
Description
Closes #1149 and moves the needle a bit on #1148
Update the documentation to better follow ADI guidelines:
USERGUIDE.md
into smaller top-level markdown files.github/workflows/build-docs.yml
since they're taken care of inDocumentation/build.py
Documentation/build.py
to be a bit easier to maintainHappy to take feedback on this and update/modify as necessary.
Testing
Best to start from a clean workspace but it should work regardless.
Checklist Before Requesting Review