TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Which websites do you use to explain your open source project?

1 pointsby msrshahrukhalmost 6 years ago
I am interested in knowing which websites or tools are commonly used by the open source developers to explain their open source projects apart from GitHub pages?<p>Or if someone wants to explain a piece of code where do they usually write about it?<p>If you are given a chance to build such a platform what would be it like?

1 comment

rootshelledalmost 6 years ago
TL;DR: Some way of generating an manual alongside the normal docs of exposed functions (API bindings).<p>Depends on the project and what is needed, generally a README.md for the big picture and an &#x2F;docs for the generated API docs, hosted on github pages &amp; friends or an webserver hooked up to the CI.<p>Which is often enough for coders but we also have a lua-jit running on top of the C++ where we have a plugin&#x2F;module system where people can create extra functionality but some of those are rather new to code. I&#x27;ve written the API docs in LDoc (the only functional lua doc generator that works with the same version as lua-jit&#x27;s lua version) but there currently isn&#x27;t a nice way to implement a more of an manual which would solve a lot of redundant questions.
评论 #20049131 未加载