SaaSHub helps you find the best software and product alternatives Learn more →
Top 23 Doc Open-Source Projects
-
SurveyJS
Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
About-SwiftUI
Gathering all info published, both by Apple and by others, about new framework SwiftUI.
-
The-Documentation-Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
-
Assemble
Get the rocks out of your socks! Assemble makes you fast at web development! Used by thousands of projects for rapid prototyping, themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websites/static site generator, an alternative to Jekyll for gh-pages and more! Gulp- and grunt-friendly.
-
docx
Easily generate and modify .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
Project mention: How We Saved 10s of Thousands of Dollars Deploying Low Cost Open Source AI Technologies At Scale with Kubernetes | dev.to | 2024-05-13One of my personal favorite OpenAI resources these days is the OpenAI Cookbook: this is an excellent way to start learning how their different models work, how to start taking advantage of the many cutting edge techniques in the AI space, and how to start integrating your data with AI workloads.
Project mention: Show HN: I made a better Perplexity for developers | news.ycombinator.com | 2024-05-08Hi HN,
I am Jiayuan, and I'm here to introduce a tool we've been building over the past few months: Devv (https://devv.ai). In simple terms, it is an AI-powered search engine specifically designed for developers.
Now, you might ask, with so many AI search engines already available—Perplexity, You.com, Phind, and several open-source projects—why do we need another one?
We all know that Generative Search Engines are built on RAG (Retrieval-Augmented Generation)[1] combined with Large Language Models (LLMs). Most of the products mentioned above use indexes from general search engines (like Google/Bing APIs), but we've taken a different approach.
We've created a vertical search index focused on the development domain, which includes:
- Documents: These are essentially the single source of truth for programming languages or libraries; I believe many of you are users of Dash (https://kapeli.com/dash) or devdocs (https://devdocs.io/).
- Code: While not natural language, code contains rich contextual information. If you have a question related to the Django framework, nothing is more convincing than code snippets from Django's repository.
- Web Search: We still use data from search engines because these results contain additional contextual information.
Our reasons for doing this include:
- The quality of the index is crucial to the RAG system; its effectiveness determines the output quality of the entire system.
- We focus more on the Index (RAG) rather than LLMs because LLMs evolve rapidly; even models performing well today may be superseded by better ones in a few months, and fine-tuning an LLM now has relatively low costs.
- All players are currently exploring what kind of LLM product works best; we hope to contribute some different insights ourselves (and plan to open source parts of our underlying infrastructure in return for contributions back into open source communities).
Some brief product features:
- Three modes: - Fast mode: Offers quick answers within seconds. - Agent mode: For complex queries where Devv Agent infers your question before selecting appropriate solutions. - GitHub mode(currently in beta): Links directly with your own GitHub repositories allowing inquiries about specific codebases.
- Clean & intuitive UI/UX design.
- Currently only available as web version but Chrome extension & VSCode plugin planned soon!
Technical details regarding how we build our Index:
- Documents section involves crawling most documentation sources using scripts inspired by devdocs project’s crawler logic then slicing them up according function/symbol dimensions before embedding into vector databases;
- Codes require special treatment beyond just embeddings alone hence why custom parsers were developed per language type extracting logical structures within repos such as architectural layouts calling relationships between functions definitions etc., semantically processed via LMM;
- Web searches combine both selfmade indices targeting developer niches alongside traditional API based methods. We crawled relevant sites including blogs forums tech news outlets etc..
For the Agent Mode, we have actually developed a multi-agent framework. It first categorizes the user's query and then selects different agents based on these categories to address the issues. These various agents employ different models and solution steps.
Future Plans:
- Build a more comprehensive index that includes internal context (The Devv for Teams version will support indexing team repositories, documents, issue trackers for Q&A)
- Fully localized: All of the above technologies can be executed locally, ensuring privacy and security through complete localization.
Devv is still in its very early stages and can be used without logging in. We welcome everyone to experience it and provide feedback on any issues; we will continue to iterate on it.
[1]: https://arxiv.org/abs/2005.11401
Docsify is frequently updated; the latest release was on June 24, 2023, and the most recent update was on December 17, 2023. It is MIT-licensed and has an active Discord community.
GitBook is a well-known online platform for developing, sharing, and publishing technical documentation. Although it’s not open source, it offers free and paid plans, with the free plan having limited features and functionalities. The paid plans unlock more features, such as custom domains, team collaboration, and advanced analytics.
Project mention: 5 Tips For Writing Technical Documentation That Developers Love | dev.to | 2024-03-08In college, an English professor would ask me and other students the following question when reviewing our essays, “Where are the examples?” Developers ask the same question when reading your documentation. To write good technical writing documents, include examples that developers can see themselves implementing in their work. How can this be done? By adding examples from your product’s codebase! 🙂 Let’s look at this code snippet from my contribution to GitHub’s documentation:
Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best practices when writing JSDoc-style comments to get your users up and running as quickly as possible:
Certain parts of Microsoft Learn are permissive, for example the .NET BCL documentation is Creative Commons Attribution: https://github.com/dotnet/dotnet-api-docs as is ASP.NET Core: https://github.com/dotnet/AspNetCore.Docs (a good hint if documentation is permissively licensed and on GitHub is if there's an edit button at the top.)
The C# language specification is unfortunately a bit fuzzier: https://github.com/dotnet/csharplang/discussions/4855
The updated unified C# language specification is CC, but it's still catching up to modern C#: https://github.com/dotnet/csharpstandard
There's also Zeal (https://zealdocs.org/) which is basically the same as Dash but open source and runs on non-Mac devices.
Project mention: 18 Must-Bookmark GitHub Repositories Every Developer Should Know | dev.to | 2024-02-12
I went to https://readthedocs.org/ and redirected me to https://about.readthedocs.com/?ref=readthedocs.org which looks proprietary now, with pricing and such.
Is it the end of this project, as we know it?
Can someone enlighten me please?
Sphinx is primarily known as a documentation generator, but it can also be used to create static websites. It excels in generating technical documentation, and its support for multiple output formats, including HTML and PDF, makes it a versatile tool. Sphinx uses reStructuredText for content creation and is highly extensible through plugins.
The Documentation Compendium
Project mention: Show HN: Nuxt.js OpenAPI / Swagger API Reference Documentation | news.ycombinator.com | 2024-04-20
Project mention: Free Godot Engine for Official Switch Developers | news.ycombinator.com | 2024-01-23There are a few companies to choose from here: https://github.com/godotengine/godot-docs/blob/master/tutori...
Project mention: Laravel: A Comprehensive Guide to Service Container and Providers | dev.to | 2024-02-16Laravel Documentation : The official Laravel documentation (https://laravel.com/docs) is a resource for of all levels. It undergoes regular updates and comprehensively covers everything from basics to advanced features.
Project mention: It's now possible to find the AWS Account ID for any S3 Bucket (private too) | news.ycombinator.com | 2024-02-26Slightly related - CloudFlare account_id and zone_id are safe to be public
https://github.com/cloudflare/cloudflare-docs/issues/474
https://community.cloudflare.com/t/api-zone-id/355566
> The Zone ID and Account ID are not sensitive. Sensitive data like account API Key, Secrets etc. can all be revoked, rotated or changed. See the comment 36 below on the Wrangler repo: as per our security team, it’s completely Fine to have your zone_id and account_id public, the Global API key and associated email address should be kept secret.
Docs related posts
-
Retype
-
Deep Dive: Google Apps Script - Testing APIs and Automating Sheets
-
How We Saved 10s of Thousands of Dollars Deploying Low Cost Open Source AI Technologies At Scale with Kubernetes
-
Why I rarely use `getByRole`: Testing Library and the first rule of ARIA
-
Question-Answer System Architectures using LLMs
-
Show HN: Nuxt.js OpenAPI / Swagger API Reference Documentation
-
The origin and virtues of semicolons in programming languages
-
A note from our sponsor - SaaSHub
www.saashub.com | 23 May 2024
Index
What are some of the best open-source Doc projects? This list will help you:
Project | Stars | |
---|---|---|
1 | openai-cookbook | 56,644 |
2 | devdocs | 34,014 |
3 | docsify | 26,778 |
4 | gitbook | 26,439 |
5 | docz | 23,520 |
6 | github-docs | 15,594 |
7 | JSDoc | 14,801 |
8 | AspNetCore.Docs | 12,379 |
9 | zeal | 11,111 |
10 | Beautiful docs | 8,931 |
11 | Read the Docs | 7,885 |
12 | About-SwiftUI | 6,930 |
13 | sphinx | 6,087 |
14 | standard-readme | 5,938 |
15 | The-Documentation-Compendium | 5,463 |
16 | codehike | 4,239 |
17 | Assemble | 4,228 |
18 | docx | 3,966 |
19 | scalar | 4,080 |
20 | godot-docs | 3,504 |
21 | docs | 2,924 |
22 | docs-next | 2,813 |
23 | cloudflare-docs | 2,606 |
Sponsored