oneapi-src / oneapi-src/level-zero-spec

Regression: L0 documentation structure change broke external links & searching

Open
#325 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
19
Forks
29
PR merge metrics
No merged PRs in 30d

Description

External links to L0 docs are now broken

Links in L0-using application's documentation and code comments to L0 documentation rely on specific structure of the L0 documentation and its link references. Changing how documentation is structured, broke all such links, e.g:

Besides breaking such links, splitting the documentation to have different API subsets under their own pages, makes automated link generation for L0 documentation (based on function and type names) significantly less convenient e.g. for L0 bindings.

API searchability lost

With earlier one-page API docs for L0 API components, it was possible to easily search the whole (e.g. Sysman) API doc for features that (potentially) cover several API subsets, using browser's page search. Splitting the API to separate pages, breaks that, and would require some kind of search functionality for the API docs site instead.

Earlier doc versions missing / site's own links are broken

Additionally, older documentation with the old structure seems to be missing, or at least is not discoverable, see e.g:

Those give either:

  • an error page with an invalid link,
  • directs to latest spec version instead of allowing user to select specific version of the documentation, or
  • a completely empty page

Expectation

Single API page which can be used to search whole API, and to reference all types & functions in generated L0 bindings documentation, preferably under versioned directory (at least major version).

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 comparing the linked current and older documentation paths, including level-zero/1.15/index.html and the level-zero-spec roots, and trace how the API pages and site links are produced. Done means a single searchable API page is available, type and function references remain usable for generated bindings, and versioned documentation links resolve to the requested version.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.