Skip to content

Commit

Permalink
fix(Documentation): Fix More Broken Links (analogdevicesinc#929)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake-Carter authored Feb 22, 2024
1 parent f6f41f3 commit dd18bc8
Show file tree
Hide file tree
Showing 839 changed files with 2,650 additions and 2,753 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ NOTE: The scope is case-sensitive and must match one of the listed scopes.

#### More Info

Please refer to the [CONTRIBUTING.md](https://github.com/Analog-Devices-MSDK/msdk/blob/main/Documentation/CONTRIBUTING.md) for more information regarding the PR Title.
Please refer to the [CONTRIBUTING.md](https://github.com/analogdevicesinc/msdk/blob/main/Documentation/CONTRIBUTING.md) for more information regarding the PR Title.
2 changes: 1 addition & 1 deletion .github/workflows/simple_per_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- uses: actions/checkout@v3
with:
submodules: false
repository: Analog-Devices-MSDK/msdk
repository: analogdevicesinc/msdk
ref: main

- name: clean
Expand Down
18 changes: 9 additions & 9 deletions Documentation/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For beginners, [learngitbranching.js.org](https://learngitbranching.js.org/) is

The MSDK follows the [GitHub contribution guidelines](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).

External contributions from outside the [Analog Devices organization](https://github.com/Analog-Devices-MSDK) should be made via a Pull Request opened from a fork. Internal contributions should also preferrably use a fork where possible.
External contributions from outside the [Analog Devices organization](https://github.com/analogdevicesinc) should be made via a Pull Request opened from a fork. Internal contributions should also preferrably use a fork where possible.

If a direct branch on the mainline MSDK repo is made, the following branch naming conventions should be used when possible:

Expand All @@ -24,7 +24,7 @@ If a direct branch on the mainline MSDK repo is made, the following branch namin
Format:
`type(scope)<!>: Subject`

For more information of the format, please review the [pull_request_template.md](https://github.com/Analog-Devices-MSDK/msdk/blob/main/Documentation/pull_request_template.md).
For more information of the format, please review the [pull_request_template.md](https://github.com/analogdevicesinc/msdk/blob/main/Documentation/pull_request_template.md).

These are the rules for the `Subject`.

Expand Down Expand Up @@ -184,11 +184,11 @@ clang-format rules are loaded from the **.clang-format** and cpplint rules are l

1. First, ensure that the example project has been linted and formatted to follow the [Style Guide](#style-guide)

2. Copy the example project into the [Examples](https://github.com/Analog-Devices-MSDK/msdk/tree/main/Examples) folder of the SDK for the applicable target microcontrollers.
2. Copy the example project into the [Examples](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder of the SDK for the applicable target microcontrollers.

3. `git add` and `git commit` the Example project. **Commit your project files before running MSDKGen.**

4. Run the [MSDKGen](https://github.com/Analog-Devices-MSDK/MSDKGen) utility to ensure the example project's support files are updated to the latest version.
4. Run the [MSDKGen](https://github.com/analogdevicesinc/MSDKGen) utility to ensure the example project's support files are updated to the latest version.

python msdkgen.py update-all --projects yourprojectname --overwrite

Expand All @@ -206,9 +206,9 @@ clang-format rules are loaded from the **.clang-format** and cpplint rules are l

## Contributing Libraries

Libraries should be added to the [Libraries](Libraries) sub-folder of the MSDK.
Libraries should be added to the `Libraries` sub-folder of the MSDK.

- All libraries should include a `libraryname.mk` file that can be added to `Libraries/libs.mk` via a toggle-switch. The filename should match the name of library as closely as possible, and expose any required [configuration variables](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/tree/develop#build-configuration).
- All libraries should include a `libraryname.mk` file that can be added to `Libraries/libs.mk` via a toggle-switch. The filename should match the name of library as closely as possible, and expose any required [configuration variables](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop#build-configuration).

- If necessary, a library may also include a "core" Makefile or set of Makefiles to build it as a standalone static library file. The naming convention is `lib<libraryname>.a`.

Expand Down Expand Up @@ -238,13 +238,13 @@ For example:
SRCS += libfile1.c
SRCS += libfile2.c

An example of this is [MiscDrivers](Libraries/MiscDrivers/), which is a simple source-file-only library. It gets its source code selectively added to the build via `Libraries/Boards/MAX78000/EvKit_V1/board.mk` files.
An example of this is `MiscDrivers`, which is a simple source-file-only library. It gets its source code selectively added to the build via files like `Libraries/Boards/MAX78000/EvKit_V1/board.mk`.

### Advanced Libraries

More advanced libraries (including those with a large number of source files) should include a rule to build as a static library file with a [recursive Make call](https://www.gnu.org/software/make/manual/make.html#Recursion).

This type of library should also set up the appropriate [configuration variables](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/tree/develop#build-configuration) to include that static library to the build.
This type of library should also set up the appropriate [configuration variables](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop#build-configuration) to include that static library to the build.

## Contributing Documentation

Expand All @@ -256,7 +256,7 @@ DoxyGen is automatically run across the MSDK code as part of the User Guide's bu

### User Guide

An MSDK User Guide is maintained in the [USERUIDE.md](USERGUIDE.md) file. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage.
An MSDK User Guide is maintained in the [USERGUIDE.md](USERGUIDE.md) file. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage.

When writing markdown links, relative paths should always be used. Additionally, links to local files on the user's filesystem **cannot** be used, since the online copy of the docs will throw a 404 on them. See [Writing Your Docs](https://www.mkdocs.org/user-guide/writing-your-docs/) for more details.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class CommonExampleInfo(ExampleInfo):
for main_file in Path(i).rglob("**/main.c"):
example_info = parse_example_info(main_file)
if example_info and example_info.name not in common_example_names:
link = f"https://github.com/Analog-Devices-MSDK/msdk/tree/release/{Path(example_info.folder).relative_to(repo).as_posix()}"
link = f"https://github.com/analogdevicesinc/msdk/tree/release/{Path(example_info.folder).relative_to(repo).as_posix()}"
table_entries.append(f"| **{example_info.name}** | {example_info.description} | _Local:_`{Path(example_info.folder).relative_to(repo)}`<br>_Github:_ [link]({link})")
markdown_content += "\n".join(sorted(table_entries))
markdown_content += "\n\n"
Expand Down
2 changes: 1 addition & 1 deletion Documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ To **get started** see the [**User Guide**](USERGUIDE.md).

For **development resources**:

* [Github](https://github.com/Analog-Devices-MSDK/msdk)
* [Github](https://github.com/analogdevicesinc/msdk)
* [Contributing](CONTRIBUTING.md)
6 changes: 3 additions & 3 deletions Examples/MAX32520/AES/.vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32520/ARM-DSP/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The projects in this folder are ports of ARM's DSP example projects that can be

Debug launch configurations are included in each project, and should appear in the "Favorites" menu in Eclipse.

Development with Visual Studio Code is also supported. See [VSCode-Maxim](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/tree/develop)
Development with Visual Studio Code is also supported. See [VSCode-Maxim](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop)

## Software

Expand Down
6 changes: 3 additions & 3 deletions Examples/MAX32520/ARM-DSP/arm_bayes_example/.vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
6 changes: 3 additions & 3 deletions Examples/MAX32520/ARM-DSP/arm_fir_example/.vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ _(If you're viewing this document from within Visual Studio Code you can press `
## Quick Links

* [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)
* [VSCode-Maxim Github](https://github.com/Analog-Devices-MSDK/VSCode-Maxim)
* [VSCode-Maxim Github](https://github.com/analogdevicesinc/VSCode-Maxim)

## Introduction

VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/Analog-Devices-MSDK/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).
VSCode-Maxim is a set of [Visual Studio Code](https://code.visualstudio.com/) project configurations and utilities for enabling embedded development for [Analog Device's MSDK](https://github.com/analogdevicesinc/msdk) and the [MAX32xxx/MAX78xxx microcontrollers](https://www.analog.com/en/product-category/microcontrollers.html).

The following features are supported:

Expand Down Expand Up @@ -37,7 +37,7 @@ See the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/#vis

## Issue Tracker

Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/Analog-Devices-MSDK/VSCode-Maxim/issues) tracker on Github.
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/analogdevicesinc/VSCode-Maxim/issues) tracker on Github.

New issues should contain _at minimum_ the following information:

Expand Down
Loading

0 comments on commit dd18bc8

Please sign in to comment.