返回首页
一周热榜
嗨，HN，我是来自Clidey的Hemang，我们正在开发Docucod。Docucod是一个能够自动生成和维护任何代码库文档的工具。
* 问题是什么？ *
我和我的联合创始人都曾在像摩根大通、摩根士丹利这样的跨国公司以及像Palantir这样的小公司工作，持续看到未维护文档带来的问题。
大多数代码库的文档不足，注释稀疏，类型并不总是明显，随着时间的推移，很多知识往往被遗忘。
深入了解后，理解事物的运作变得越来越困难。这会减慢新员工的入职速度，浪费调试时的时间，并增加出错的可能性。
直到今天，我们一直在与中小型公司和初创企业进行试点，调整产品并获得大量反馈。
今天，我们希望向公众开放，发布生成服务！
* 试试看！ *
请访问 <a href="https://docucod.com/oss" rel="nofollow">https://docucod.com/oss</a>，并在此处输入您的代码库URL。生成后，链接将可见。
您还可以在代码库URL前加上前缀URL：<a href="https://docucod.com/docs/<repo-url>" rel="nofollow">https://docucod.com/docs/<repo-url></a>（例如：<a href="https://docucod.com/docs/https://github.com/clidey/whodb" rel="nofollow">https://docucod.com/docs/https://github.com/clidey/whodb</a>）
请注意，这仅适用于大小不超过100MB的公共代码库。
<i>工作原理：</i>
Docucod分析代码库，解析文件、注释、类型、示例和自述文件，然后构建一个您可以立即浏览的静态文档网站——无需配置，无需设置。
它会自动提取有用的上下文，这样您就不必逐行阅读代码来弄清楚发生了什么。
它支持使用Mermaid生成图表，我们还在努力生成图像，未来还会支持视频！
发布是通过我们自己的静态网站生成器<i>Dory</i>完成的（[<a href="https://github.com/clidey/dory">https://github.com/clidey/dory</a>](<a href="https://github.com/clidey/dory">https://github.com/clidey/dory</a>)）。
它处理解析、结构提取和HTML生成。Dory的构建考虑了处理AI生成的MDX，这是一个有趣的挑战。
我们仍在完善它，因此欢迎提出PR和反馈。
<i>接下来是什么：</i>
目前我们支持公共GitHub代码库（私有支持即将推出）。我们还在开发一些功能，比如在文档中进行代码搜索、根据用户查询定制响应、更好的导航、主题定制以及与CI管道的集成。
如果您试用一下，我非常希望能得到您的反馈——无论是好的还是坏的。它是否解决了您的实际问题？有什么让您困惑的地方、缺失的内容，或者根本没有帮助的地方？
谢谢！
[讨论]<p>你好，<p>我16岁，想找一个实习机会，但似乎找一个实习几乎是不可能的。我主要使用C++编程，并且对此非常熟练。我在GitHub上有两个成功的项目（700多个星标，50多个星标），背后也有一个庞大的社区支持，但无论我展示什么，我都无法获得工作机会，因为除了我的GCSE成绩外，我没有任何高中水平的资格，而我的GCSE成绩还没有出来。<p>我还尝试通过抓取公司员工的电子邮件地址来给他们发邮件，但没有得到任何回复，这也在意料之中。<p>在像r/Internships这样的地方，我也看到有人抱怨无薪实习与现代奴隶制相提并论，这让我对想要实习的愿望打了折扣。无论如何，我在一家初创公司有过真实工作的经验，这份工作是通过人脉获得的，这让我更加珍惜自己的劳动所得。<p>如果你有任何建议能帮助我进一步发展，我将不胜感激，因为我感觉自己陷入了死胡同。<p>如果你对我的项目感兴趣，可以查看：github.com/uint23
这里是来自Temporal的Steve。Temporal是一个麻省理工学院的开源项目，旨在实现可靠的大规模执行。我对OpenAI的Agents SDK示例进行了适配和扩展，以便与Temporal集成。
这些演示代理能够在进程崩溃时继续运行，支持数百万次并行执行，并且实现人机交互非常简单。只需在您的OpenAI代理代码中添加几个Python装饰器，运行Temporal工作节点，您就可以开始使用了。
请查看我与OpenAI合作制作的视频，展示了这一过程（链接在仓库中）。
OpenAI实际上在ChatGPT图像和他们的Codex代码编写代理中使用了我们的技术，因此我认为这可能是其他人编写简单且可靠的可扩展代码的可行路径。
欢迎提出问题。
我在CloudFlare有一个付费账户，但似乎无法联系到他们的支持人员。
我还注意到我的IP地址被一半的互联网屏蔽了。不知道为什么。我的工作使用BT来分发定制的Debian镜像，但据我所知，这些镜像中没有任何受版权保护的材料。也许我的ISP告诉CloudFlare我很糟糕，因为它看到BT并且不在乎找不到版权侵权的证据？
因此，大约一半的时间，CloudFlare的仪表板都会被一个消息屏蔽，告诉我应该给我试图访问的网站发送电子邮件，请他们解锁我。但我试图联系的正是CloudFlare，而他们的支持人员没有回应（即使我尝试给他们发送电子邮件）。
我的意思是……我想是时候转向Akamai了。但CloudFlare仍然污染了我的IP。
此外……如果一个CDN要屏蔽对某个网站数据的访问，并说“发电子邮件给网站以恢复访问”，那么他们应该有一个可以用来联系的电子邮件地址。如果我必须去网站上查找我需要发送消息的电子邮件地址，而那个网站又被屏蔽了……
难道我还要为不被使用他们服务的人屏蔽而向CloudFlare付费吗？这难道变成了保护费吗？
总之……如果有人知道如何联系CloudFlare的支持，或许通过电话，那将不胜感激。
我的理论：广告与资本主义本身非常相似。
广告和资本主义都很复杂，并且存在一些外部化的危害，但它们比其他替代方案要好。
在“以广告为主导”的客户发现模型中，企业通过广告向市场传达它们的存在及所提供的服务。它们通过在各种媒介上支付广告费用来实现这一点。这包括从店面标识到Craigslist广告，再到电视和复杂的数字广告。
大多数现代广告实际上是一场拍卖，企业竞争向算法认为最有可能感兴趣的客户传达其信息。
这种功能——将可能对产品感兴趣的用户与提供产品的企业进行匹配——目前已经大规模扩展。
希望禁止广告的人通常会提出一个替代方案，即为每个类别提供经过审核的产品和服务目录。他们认为，这将是理想的产品发现方式，配合口碑传播。
然而，这立即面临着与历史上共产主义相同的问题。究竟谁来控制这些目录，这将成为社会的巨大权力源泉？我认为，中央集权有效地管理这一点是不可能的，而最有效的理念和产品传播方式更接近现代营销和广告。