From 52d896cd27601806d0712513617b62051a04dc8e Mon Sep 17 00:00:00 2001 From: Noah Schiro <59176275+NoahSchiro@users.noreply.github.com> Date: Sun, 4 Aug 2024 15:38:18 -0400 Subject: [PATCH] Fix broken links in contributor book (#2061) --- contributor-book/src/SUMMARY.md | 10 +++++----- .../{Readme.md => README.md} | 0 .../src/getting-started/{ReadMe.md => README.md} | 0 ...leSerialization.png => module-serialization.png} | Bin .../src/project-architecture/serialization.md | 2 +- .../project-architecture/{Tensor.md => tensor.md} | 0 6 files changed, 6 insertions(+), 6 deletions(-) rename contributor-book/src/frequently-encountered-issues/{Readme.md => README.md} (100%) rename contributor-book/src/getting-started/{ReadMe.md => README.md} (100%) rename contributor-book/src/project-architecture/{ModuleSerialization.png => module-serialization.png} (100%) rename contributor-book/src/project-architecture/{Tensor.md => tensor.md} (100%) diff --git a/contributor-book/src/SUMMARY.md b/contributor-book/src/SUMMARY.md index fcf4c3b9f..885a9cb5a 100644 --- a/contributor-book/src/SUMMARY.md +++ b/contributor-book/src/SUMMARY.md @@ -1,16 +1,16 @@ - [Overview](./overview.md) - [How to Read This Book](./how-to-read-this-book.md) -- [Getting Started](./getting-started/ReadMe.md) +- [Getting Started](./getting-started/README.md) - [Setting Up The Environment](./getting-started/setting-up-the-environment.md) - [Configuring Your Editor (Optional)](./getting-started/configuring-your-editor.md) - [Testing](./getting-started/testing.md) -- [Architecture Overview](./project-architecture/ReadMe.md) +- [Architecture Overview](./project-architecture/README.md) - [Modules](./project-architecture/module.md) - [Serialization](./project-architecture/serialization.md) - - [Tensor](./project-architecture/Tensor.md) + - [Tensor](./project-architecture/tensor.md) - [Backend](./project-architecture/backend.md) -- [Guides for Contributors](./guides/ReadMe.md) +- [Guides for Contributors](./guides/README.md) - [Onnx To Burn Conversion Tool: A Development Guide](./guides/onnx-to-burn-conversion-tool.md) - [Adding a New Operation to Burn](./guides/adding-a-new-operation-to-burn.md) -- [Frequently Encountered Issues](./frequently-encountered-issues/ReadMe.md) +- [Frequently Encountered Issues](./frequently-encountered-issues/README.md) - [Issues Related To Adding Operators](./frequently-encountered-issues/issues-while-adding-ops.md) diff --git a/contributor-book/src/frequently-encountered-issues/Readme.md b/contributor-book/src/frequently-encountered-issues/README.md similarity index 100% rename from contributor-book/src/frequently-encountered-issues/Readme.md rename to contributor-book/src/frequently-encountered-issues/README.md diff --git a/contributor-book/src/getting-started/ReadMe.md b/contributor-book/src/getting-started/README.md similarity index 100% rename from contributor-book/src/getting-started/ReadMe.md rename to contributor-book/src/getting-started/README.md diff --git a/contributor-book/src/project-architecture/ModuleSerialization.png b/contributor-book/src/project-architecture/module-serialization.png similarity index 100% rename from contributor-book/src/project-architecture/ModuleSerialization.png rename to contributor-book/src/project-architecture/module-serialization.png diff --git a/contributor-book/src/project-architecture/serialization.md b/contributor-book/src/project-architecture/serialization.md index 0ee178a93..143a14606 100644 --- a/contributor-book/src/project-architecture/serialization.md +++ b/contributor-book/src/project-architecture/serialization.md @@ -45,7 +45,7 @@ main types and traits used in the solution.

Module Serialization Types

- +
The way the types interact with each other is pretty straightforward. First, a module can be diff --git a/contributor-book/src/project-architecture/Tensor.md b/contributor-book/src/project-architecture/tensor.md similarity index 100% rename from contributor-book/src/project-architecture/Tensor.md rename to contributor-book/src/project-architecture/tensor.md