Skip to content

Regression: L0 documentation structure change broke external links & searching #325

Description

@eero-t

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).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions