X Tutup
Skip to content

Commit e86298d

Browse files
chore: fix relative links in docs and enforce we dont break them again (electron#14832)
1 parent 46141b8 commit e86298d

File tree

6 files changed

+6
-5
lines changed

6 files changed

+6
-5
lines changed

docs/development/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For guides on Electron app development, see
1313
* [Coding Style](coding-style.md)
1414
* [Using clang-format on C++ Code](clang-format.md)
1515
* [Build System Overview](build-system-overview.md)
16-
* [Build Instructions (macOS)](build-instructions-osx.md)
16+
* [Build Instructions (macOS)](build-instructions-macos.md)
1717
* [Build Instructions (Windows)](build-instructions-windows.md)
1818
* [Build Instructions (Linux)](build-instructions-linux.md)
1919
* [Chromium Development](chromium-development.md)

docs/development/build-instructions-gn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Follow the guidelines below for building Electron.
66

77
Check the build prerequisites for your platform before proceeding
88

9-
* [macOS](build-instructions-osx.md#prerequisites)
9+
* [macOS](build-instructions-macos.md#prerequisites)
1010
* [Linux](build-instructions-linux.md#prerequisites)
1111
* [Windows](build-instructions-windows.md#prerequisites)
1212

docs/development/debugging-instructions-macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ you prefer a graphical interface.
1212

1313
* **A debug build of Electron**: The easiest way is usually building it
1414
yourself, using the tools and prerequisites listed in the
15-
[build instructions for macOS](build-instructions-osx.md). While you can
15+
[build instructions for macOS](build-instructions-macos.md). While you can
1616
attach to and debug Electron as you can download it directly, you will
1717
find that it is heavily optimized, making debugging substantially more
1818
difficult: The debugger will not be able to show you the content of all

docs/development/pull-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ $ git fetch upstream
3535

3636
Build steps and dependencies differ slightly depending on your operating system.
3737
See these detailed guides on building Electron locally:
38-
* [Building on MacOS](https://electronjs.org/docs/development/build-instructions-osx)
38+
* [Building on MacOS](https://electronjs.org/docs/development/build-instructions-macos)
3939
* [Building on Linux](https://electronjs.org/docs/development/build-instructions-linux)
4040
* [Building on Windows](https://electronjs.org/docs/development/build-instructions-windows)
4141

script/check-relative-doc-links.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ def main():
3232
' files within docs directory and its ' +
3333
str(totalDirs) + ' subdirectories.')
3434
print('Found ' + str(totalBrokenLinks) + ' broken relative links.')
35+
return totalBrokenLinks
3536

3637

3738
def getBrokenLinks(filepath):

script/tls.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def check_tls(verbose):
3030
if sys.platform == "linux" or sys.platform == "linux2":
3131
tutorial = "./docs/development/build-instructions-linux.md"
3232
elif sys.platform == "darwin":
33-
tutorial = "./docs/development/build-instructions-osx.md"
33+
tutorial = "./docs/development/build-instructions-macos.md"
3434
elif sys.platform == "win32":
3535
tutorial = "./docs/development/build-instructions-windows.md"
3636
else:

0 commit comments

Comments
 (0)
X Tutup