From c40a1bdbc368127c2e1c3d8d517a97c8354740b8 Mon Sep 17 00:00:00 2001 From: Aaryan Kumar Sinha Date: Fri, 5 Dec 2025 23:32:28 +0530 Subject: [PATCH 1/2] fix: fixed the broken links in docs --- docs/CONTRIBUTING.md | 7 +++++++ docs/{license.md => LICENSE.md} | 0 docs/index.md | 1 + mkdocs.yml | 2 +- 4 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/CONTRIBUTING.md rename docs/{license.md => LICENSE.md} (100%) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..8583671 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,7 @@ +--- +title: libzim Contribution +--- + +{% + include-markdown "../CONTRIBUTING.md" +%} \ No newline at end of file diff --git a/docs/license.md b/docs/LICENSE.md similarity index 100% rename from docs/license.md rename to docs/LICENSE.md diff --git a/docs/index.md b/docs/index.md index 2cadb0d..6cae110 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,4 +4,5 @@ title: libzim Documentation {% include-markdown "../README.md" + rewrite-relative-urls=false %} diff --git a/mkdocs.yml b/mkdocs.yml index d2a5da6..b5df89b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,7 @@ nav: - Home: index.md - API Reference: api_reference/ - Changelog: 'changelog.md' - - License: license.md + - License: LICENSE.md theme: name: material From 47b2625bd40ac8430628d4a4b65f2c6e52fa7875 Mon Sep 17 00:00:00 2001 From: Aaryan Kumar Sinha Date: Sun, 7 Dec 2025 02:22:37 +0530 Subject: [PATCH 2/2] added contributing to menu; updated changelog --- CHANGELOG.md | 2 ++ mkdocs.yml | 1 + 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e6fdb4d..ae3f0c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +* fixed broken links in docs + ### Added - Added Changelog to docs. diff --git a/mkdocs.yml b/mkdocs.yml index b5df89b..4de3f8a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,7 @@ nav: - Home: index.md - API Reference: api_reference/ - Changelog: 'changelog.md' + - Contributing: CONTRIBUTING.md - License: LICENSE.md theme: