ironcore-dev / ironcore-dev/ironcore-dev.github.io

API Reference Links between different API groups are broken

Open
#132 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Makefile
Stars
3
Forks
8
Avg merge
1d 17h
Merged PRs (30d)
9

Description

Describe the bug

E.g. on the compute API reference clicking on the link for the volume template leads to a 404.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by opening the compute API reference URL in the issue and reproduce the broken volume-template link. Trace how links between API groups are generated in the documentation, then verify that the reported link and other cross-group API links resolve instead of returning 404s.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.