Boost.Graph 文档现代化的初步探索
大家好,Boost Graph 社区!我们已经开始对 Boost.Graph 文档进行现代化改造,预览版可在此查看。此次改进旨在解决用户在 2022 年用户调查和 BGL 研讨会中反馈的常见问题,包括:
- 文档难以浏览(缺乏目录和搜索功能)
- 示例使用过时的 C++,部分甚至无法编译
- 视觉设计陈旧
我们在多个方面进行了投入:
- 将旧的纯 HTML 页面迁移至 Asciidoc + Antora
- 为每个算法编写现代示例,并在 CI 中编译和运行,输出整合入文档
- 提高算法复杂度的可扫描性及其定义的位置
- 为不熟悉属性图的用户提供更好的入口
目前的 PR 还未合并,因为我们正在评估其可行性。重要的是:这不是最终愿景,而是一个重要的第一步。目前的范围不是对每个算法页面进行全面重写或重组,而是对文档基础设施进行现代化。我们担心可能犯了重要错误,可能会阻止合并。
社区提问:
- 新文档预览的方向正确吗?
- 是否比旧文档更好?
- 你希望在当前状态下合并吗,还是希望在合并前修复重要错误?
欢迎任何与此 PR 范围无关的常规反馈,我们将在未来的工作中整合!感谢大家的时间。
博主点评: Boost.Graph 文档的现代化是一个必然趋势,尤其是在用户体验和可访问性方面的提升。通过引入现代技术和工具,能够有效减少用户的学习曲线,提升文档的实用性。然而,在合并之前,社区的反馈至关重要,以确保文档的质量和准确性。希望开发者能够认真对待用户的意见,确保最终版本能够得到广泛认可。