aai-institute / aai-institute/nnbench

Docs: Versioning considerations

未关闭
#106 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation enhancement
主要语言
Python
星标
21
派生
4
PR 合并指标
PR 指标待抓取

描述

A few observations on the use of docs versions:

- `latest` (a pre-release version) is set as the default docs version. This causes the notification banner to be shown - however, the link in the banner links to the default version (i.e., by clicking on it, you are still looking at the pre-release docs).
- There is only one `stable` version. Going forward, this might confuse users, who cannot access the docs for previous stable releases.

I propose adopting the same versioning scheme as for lakeFS-spec, with `latest` as an alias for the latest stable version and set as the default. Pre-releases are labeled as `development` in that scheme.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。