Skip to content

Commit

Permalink
docs: Make README links work if viewed in code repository
Browse files Browse the repository at this point in the history
An unexpected feature of the README-to-GitHub Pages conversion is that
any link in the docs/README.md that refers to a **generated** file, will
of course appear as 404 if it was clicked from within the code
repository.

The root of the GitHub pages is generated from README.md, which is of
course easy to find (and even displayed automatically by GitHub while
navigating the code tree into the docs directory).

Generated files are not stored in the repository, so those links only
work when the README is viewed as part of the GitHub Pages.
The old style works from within the GitHub pages where the generated
files actually exist.

Specifying an absolute URL for each one feels less future-proof than a
relative path, but it needs to be done so that there are not broken
links for anyone who finds the README via the code repository tree
instead of the GitHub Pages.

The links to files that are static (exist already under docs) were
left as relative links, since they work in both situations.

Signed-off-by: Gunnar Andersson <[email protected]>
  • Loading branch information
gunnar-mb committed Jan 23, 2024
1 parent 01eae46 commit 605c32f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# IFEX Documentation Overview

- Main specification with introduction, examples, and the syntax of the core IDL/model: [ifex-specification.md](./ifex-specification.md)
- Tips and information for developers: [developers-manual.md](./developers-manual.md) (WIP)
- There is also a [Frequently Asked Questions](FAQ.md) file
- Main specification with introduction, examples, and the syntax of the core IDL/model: [ifex-specification.md](https://covesa.github.io/ifex/ifex-specification)
- Tips and information for developers: [developers-manual.md](https://covesa.github.io/ifex/developers-manual) (WIP)
- There is also a [Frequently Asked Questions](./FAQ.md) file

----
#### Writing documentation
Expand Down

0 comments on commit 605c32f

Please sign in to comment.