chipsalliance/chisel

Broken Links on Chisel-Lang.org docs

Chiusa

#3317 aperta il 1 giu 2023

 (1 commento) (0 reazioni) (0 assegnatari)Scala (651 fork)batch import
good first issue

Metriche repository

Star
 (4658 stelle)
Metriche merge PR
 (Merge medio 3g 21h) (16 PR mergiate in 30 g)

Descrizione

I found a few broken links on the docs. Here is a diff identifying what I think should be fixes for them. (In the case of one, removing it entirely). I don't have a quick way to build and test, though, so I will just leave this as an issue for someone who has their environment set up:

diff --git a/docs/src/cookbooks/cookbook.md b/docs/src/cookbooks/cookbook.md
index 250d512f9..9df75bb0a 100644
--- a/docs/src/cookbooks/cookbook.md
+++ b/docs/src/cookbooks/cookbook.md
@@ -264,8 +264,8 @@ getVerilogString(new Foo)

 ### How do I partially reset an Aggregate Reg?

-The easiest way is to use a partially-specified [Bundle Literal](#../appendix/experimental-features#bundle-literals)
-or [Vec Literal](#../appendix/experimental-features#vec-literals) to match the type of the Reg.
+The easiest way is to use a partially-specified [Bundle Literal](../appendix/experimental-features#bundle-literals)
+or [Vec Literal](../appendix/experimental-features#vec-literals) to match the type of the Reg.

 ```scala mdoc:silent:reset
 import chisel3._
diff --git a/docs/src/explanations/connectable.md b/docs/src/explanations/connectable.md
index fd5729c3b..e62b12fad 100644
--- a/docs/src/explanations/connectable.md
+++ b/docs/src/explanations/connectable.md
@@ -55,7 +55,7 @@ The `Connectable` operators are the standard way to connect Chisel hardware comp

 All connection operators require the two hardware components (consumer and producer) to be structurally type equivalent.

-The one exception to the structural type-equivalence rule is using the `Connectable` mechanism, detailed at this [section](#waived-data) towards the end of this document.
+The one exception to the structural type-equivalence rule is using the `Connectable` mechanism, detailed at this section towards the end of this document.

 Aggregate (`Record`, `Vec`, `Bundle`) Chisel types can include data members which are flipped relative to one another.
 Due to this, there are many desired connection behaviors between two Chisel components.
diff --git a/docs/src/introduction.md b/docs/src/introduction.md
index 3b68aae2f..71dc28175 100644
--- a/docs/src/introduction.md
+++ b/docs/src/introduction.md
@@ -27,7 +27,7 @@ For quick reference "How-To" guides see the [Cookbooks](cookbooks/cookbooks).
 For a deeper introduction to key concepts in  Chisel see the [Explanations](explanations/explanations).

 The [API Documentation](https://www.chisel-lang.org/api/) gives the detailed reference for the Chisel source code.
-Note that previous versions can be found via the sidebar menu at [https://www.chisel-lang.org/chisel3].
+Note that previous versions can be found via the sidebar menu at [https://www.chisel-lang.org/chisel3](https://www.chisel-lang.org/chisel3).

 The [Resources](resources/resources) provides links to other useful resources for learning and working with Chisel.

Guida contributor