Skip to content

Commit 9c2c87e

Browse files
committed
doc: check and fix urls
use 'make linkcheck' to check urls Signed-off-by: Jingru Wang <jingru@synopsys.com>
1 parent 7922b8c commit 9c2c87e

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

doc/documents/contribute/CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ What should I know before I get started?
4747
Code of Conduct
4848
===============
4949

50-
This project adheres to the Contributor Covenant `code of conduct <./CODE_OF_CONDUCT.md>`_.
50+
This project adheres to the Contributor Covenant :ref:`code of conduct <code_guidelines>`.
5151
By participating, you are expected to uphold this code.
5252
Please report unacceptable behavior to `info@embarc.org <mailto:info@embarc.org>`_.
5353

@@ -160,7 +160,7 @@ Enhancement suggestions are tracked as `GitHub issues <https://guides.github.com
160160
* **List some other text software platform where this enhancement exists.**
161161
* **Specify the name and version of the OS you're using.**
162162

163-
`Template For Submitting Enhancement Suggestions <./ISSUE_TEMPLATE.md>`_
163+
:ref:`Template For Submitting Enhancement Suggestions <issue_guidelines>`
164164
------------------------------------------------------------------------
165165

166166
Your First Code Contribution

doc/documents/example/example.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,5 @@ The following application notes provide step-by-step instructions on a broad ran
7272
* `How to create your own peripheral modules for use with the ARC EMSK and embARC <https://foss-for-synopsys-dwc-arc-processors.github.io/pdf/20151013_embARC_application_note_create_module_EMSK_embARC_v3.pdf>`_
7373
* `Timer and ISR <https://foss-for-synopsys-dwc-arc-processors.github.io/pdf/20150805_embARC_application_note_timer_and_isr.pdf>`_
7474
* `Using a secondary bootloader on the EMSK <https://foss-for-synopsys-dwc-arc-processors.github.io/pdf/20150710_embARC_application_note_secondary_bootloader.pdf>`_
75-
* `Using a smart home IoT application with EMSK <https://foss-for-synopsys-dwc-arc-processors.github.io/pdf/embARC_appnote_how_to_use_smart_home_iot.pdf>`_
7675

7776
.. note:: Confirm that the version of embARC OSP and board is the correct one as noted in the application note documents

doc/documents/getting_started/peripheral_preparation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Other PMOD or Compatible Modules
7474
`Pmod AD2 <https://reference.digilentinc.com/reference/pmod/pmodad2/start>`_ : ADC type is AD7991, use **I2C** for data collection.
7575
Driver code at ``embarc_osp/device/peripheral/adc/ad7991``.
7676

77-
`ESP01\/ESP01S <https://wiki.ai-thinker.com/esp8266/docs>`_ : Primary IC type is ESP8266, use **UART** interface for data changing and controlling.
77+
`ESP01\/ESP01S <https://www.espressif.com/en/support/documents/technical-documents>`_ : Primary IC type is ESP8266, use **UART** interface for data changing and controlling.
7878
Driver code at ``embarc_osp/device/peripheral/wifi/slip_esp``.
7979

80-
The ESP01/ESP01S module is not originally a PMOD module, however it is PMOD compatible, meaning that you can wire it to PMOD interface on board. You need to connect GND(embARC) to GND(ESP) , 3.3V(embARC) to VCC(ESP), RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <https://wiki.ai-thinker.com/esp8266/docs>`_ and UART (type 4A) part of `Digilent Pmod Spec <https://www.digilentinc.com/Pmods/Digilent-Pmod_%20Interface_Specification.pdf>`_ for pin layout.
80+
The ESP01/ESP01S module is not originally a PMOD module, however it is PMOD compatible, meaning that you can wire it to PMOD interface on board. You need to connect GND(embARC) to GND(ESP) , 3.3V(embARC) to VCC(ESP), RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <https://www.espressif.com/en/support/documents/technical-documents>`_ and UART (type 4A) part of `Digilent Pmod Spec <https://www.digilentinc.com/Pmods/Digilent-Pmod_%20Interface_Specification.pdf>`_ for pin layout.

doc/documents/license/license.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ AWS IoT Device C SDK
7979
********************
8080

8181
:Project homepage: https://github.com/aws/aws-iot-device-sdk-embedded-C
82-
:Project licensing: https://github.com/aws/aws-iot-device-sdk-embedded-C/blob/master/LICENSE.txt
82+
:Project licensing: https://github.com/aws/aws-iot-device-sdk-embedded-C/blob/master/LICENSE
8383
:LICENSE: `Apache License`_
8484

8585
Doxygen
@@ -227,8 +227,8 @@ MRF24WG0MA PMOD WiFi
227227
NT-Shell
228228
********
229229

230-
:Project homepage: https://www.cubeatsystems.com/ntshell/
231-
:Project licensing: | https://www.cubeatsystems.com/ntshell/license.html
230+
:Project homepage: https://cubeatsystems.com/ntshell/
231+
:Project licensing: | https://cubeatsystems.com/ntshell/license.html
232232
| The license
233233
| • vtparse, vtparse_table are in the public domain.
234234
| • ntshell, ntopt, ntlibc, text_editor, text_history are in the MIT license.

0 commit comments

Comments
 (0)