stackabletech / stackabletech/documentation

Explore alternatives to Antora for documentation

未关闭
#650 3 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
CSS
星标
13
派生
14
平均合并
4 天 8 小时
30 天内合并 PR
10

描述

[!IMPORTANT]
This issue is not a commitment to replacing Antora. It is just to record the frustrations of the current documentation workflow, look into alternatives, do timeboxed trials, and understand what we then lose by switching.

Acceptance
  • List shortcomings of the status-quo (Antora)
  • List things we like about the status-quo (Antora)
  • Timeboxed trial of select alternatives to understand the tradeoffs

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

没有指定文件、测试或入口点。首先记录 Antora 的文档工作流,将其不足与优势分开,然后对选定的替代方案进行限时试验,并记录每个选项的权衡和损失。

由索引模型根据 Issue 内容生成。

评估

领域
documentation
Issue 类型
重构
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

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