← All tasks
javascriptAxonIQ/AxonFramework #4063Not a task: not reproduced

Update documentation README/contribution guide

envgap__AxonIQ__AxonFramework-4063

01 / FAILURE SIGNATURE

As reported upstream

No identifying execution failure has been captured.
Not a benchmark task.
  • In a clean container the reported failure did not reproduce, or the known fix did not make the project run.

02 / ENVIRONMENT RECIPE

Base commit
abe103abd9213055d4c64b9260f5526782909d64
Manifest
docs/_playbook/package.json
Reproduce
Awaiting issue-specific recipe
Run under trace
Awaiting a meaningful runtime command

03 / ORIGINAL ISSUE TEXT

AxonIQ/AxonFramework #4063 · read the original issue
As a framework contributor, I want to be able to run the antora documentation locally to verify changes before adding PRs.

### Suggested Documentation change

* All links in the opening section are broken (404)
* The link to the `[AxonIQ Library Contribution Guide](https://docs.axoniq.io/contribution_guide/index.html)` is broken
* The link to the `[detailed information on how the process to build the docs works](https://docs.axoniq.io/contribution_guide/overview/build.html)` is broken
* Point 1: _Make sure you have Node (a LTS version is preferred), Antora and Vale installed in your system._ -> only node and vale need to be provided, antora-cli comes via npm install/`package.json`

Note: We also discussed wether a custom README in the axon-framework docs is required, as antora does a multi-repo doc and there could be just one single README how to use it.
Continue on GitHub ↗

04 / LABELS

Labels from the report text only; not yet run

No supported category has been assigned.

Label rules and the text that matched
[]