mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git

Patrick Kollitsch
10 hours ago 9675ff2dc36a5448f31e918676c402f7fa5b8f4a
docs: update current documentation links to GitHub Pages

Signed-off-by: Patrick Kollitsch <davidsneighbourdev+gh@gmail.com>
3 files modified
24 ■■■■■ changed files
CONTRIBUTING.md 8 ●●●●● patch | view | raw | blame | history
README.md 14 ●●●●● patch | view | raw | blame | history
tests/catalog.yaml 2 ●●●●● patch | view | raw | blame | history
CONTRIBUTING.md
@@ -29,7 +29,7 @@
The project follows a structured release workflow based on conventional commits, staging branches, and automated versioning.
For details, see [Branch Strategy](#branch-strategy). Publish a stable theme release from `main` before publishing the matching documentation. The documentation production build resolves the latest stable theme without changing its checked-in dependency files; preview builds can select an unreleased ref. Follow the [release and publication order](https://ananke-documentation.netlify.app/help/development/#release-and-publication-order), and confirm the resolved theme version in the documentation build log.
For details, see [Branch Strategy](#branch-strategy). Publish a stable theme release from `main` before publishing the matching documentation. The documentation production build resolves the latest stable theme without changing its checked-in dependency files; preview builds can select an unreleased ref. Follow the [release and publication order](https://gohugo-ananke.github.io/documentation/help/development/#release-and-publication-order), and confirm the resolved theme version in the documentation build log.
## Before you start
@@ -144,14 +144,14 @@
Every pull request with a user-facing change needs a matching pull request in the documentation repository, or a short reason in the pull request template why no change is needed. The check "Require a documentation decision" fails on pull requests into `development` until the documentation item is checked and the line "Documentation PR or reason:" has a value. Dependabot pull requests are exempt. The documentation organises pages by reader need: tutorials, how-to guides, explanation, and reference. Change only the document types that the change affects:
* **New or changed option or shortcode:** update its row in the [configuration reference](https://ananke-documentation.netlify.app/configuration/reference/) or its shortcode reference page. Give the type, default, scope (site, page, or both), the first release, and an example that you tested. Add or update the `docs` path of the entry in `tests/catalog.yaml`; the coverage gate requires it.
* **New or changed option or shortcode:** update its row in the [configuration reference](https://gohugo-ananke.github.io/documentation/configuration/reference/) or its shortcode reference page. Give the type, default, scope (site, page, or both), the first release, and an example that you tested. Add or update the `docs` path of the entry in `tests/catalog.yaml`; the coverage gate requires it.
* **Changed task or workflow:** update the how-to guide that describes it.
* **Breaking change or deprecation:** add the change to [Update Ananke](https://ananke-documentation.netlify.app/get-started/update-ananke/#changes-that-need-action) and link an upgrade guide.
* **Breaking change or deprecation:** add the change to [Update Ananke](https://gohugo-ananke.github.io/documentation/get-started/update-ananke/#changes-that-need-action) and link an upgrade guide.
* **New concept or trade-off:** add or update an explanation page only when readers need it to make a choice. A feature does not need one page of each type.
Mark a new feature with the `since` shortcode and its first release. Until that release is published, keep the documentation pull request unmerged, or mark the content as a preview. Do not describe unreleased behaviour as available.
Publish the documentation only after the stable theme release, in the [release and publication order](https://ananke-documentation.netlify.app/help/development/#release-and-publication-order).
Publish the documentation only after the stable theme release, in the [release and publication order](https://gohugo-ananke.github.io/documentation/help/development/#release-and-publication-order).
## Attribution
README.md
@@ -5,7 +5,7 @@
![Ananke screenshot](images/screenshot.png)
* Demo: [gohugo-ananke.github.io/documentation](https://gohugo-ananke.github.io/documentation/)
* Documentation: [ananke-documentation.netlify.app](https://ananke-documentation.netlify.app/)
* Documentation: [gohugo-ananke.github.io/documentation](https://gohugo-ananke.github.io/documentation/)
* Changelog: [CHANGELOG.md](CHANGELOG.md)
> [!IMPORTANT]
@@ -43,8 +43,8 @@
Ananke supports both installation methods:
* [Install as Hugo Module (recommended)](https://ananke-documentation.netlify.app/installation/gohugo-module/)
* [Install as Git Submodule](https://ananke-documentation.netlify.app/installation/git-submodule/)
* [Install as Hugo Module (recommended)](https://gohugo-ananke.github.io/documentation/get-started/hugo-module/)
* [Install as Git Submodule](https://gohugo-ananke.github.io/documentation/get-started/git-submodule/)
If you are new to Hugo, see Hugo's official quick start: [gohugo.io/getting-started/quick-start](https://gohugo.io/getting-started/quick-start/).
@@ -52,10 +52,10 @@
After installation, use these guides to configure your site:
* [Getting Started](https://ananke-documentation.netlify.app/getting-started/)
* [Configuration](https://ananke-documentation.netlify.app/configuration/)
* [Customisation](https://ananke-documentation.netlify.app/customisation/)
* [Troubleshooting](https://ananke-documentation.netlify.app/troubleshooting/)
* [Getting Started](https://gohugo-ananke.github.io/documentation/get-started/)
* [Configuration](https://gohugo-ananke.github.io/documentation/configuration/)
* [Customisation](https://gohugo-ananke.github.io/documentation/customisation/)
* [Troubleshooting](https://gohugo-ananke.github.io/documentation/help/troubleshooting/)
## Support and contributions
tests/catalog.yaml
@@ -6,7 +6,7 @@
#
# `tests` entries must name existing executable spec or quickstart files.
# Every entry also needs `docs`: the documentation page as a site-relative
# path on https://ananke-documentation.netlify.app. The gate checks only
# path on https://gohugo-ananke.github.io/documentation. The gate checks only
# its format.
# This checks registration and paths, not whether assertions cover every behaviour.