Building DocFit - Github CI for Documentation

Siddharth Singh • Peerlist

DocFit is a GitHub App for one job: keeping API documentation in step with the code that just merged. The problem is familiar to anyone who maintains API docs, public or private. A pull request merges, the code is correct, and a docs page is now wrong. Often it isn't the headline change. In our public example, a PR titled "filter refunds by reason" also lowered the maximum page size from 100 to 50, and the docs page never listed the limit at all. Nobody reviewing the code saw the docs page; nobody owning the docs saw the code PR. What DocFit does on every merge: 1. Decides whether docs could be affected. If not, it leaves a "No docs impact" comment and stops. 2. Reads the whole change: diff, commits, review comments and the linked Jira or GitHub issue. 3. Finds affected pages using the OpenAPI diff, exact names from the code (routes, enums, env vars, CLI flags) and search over your docs, with a reason for each page. 4. Fixes the documentation in your documentation framework's format. 5. Checks it: your docs build and linters, links, OpenAPI lint, and any custom commands. 6. Opens a docs PR for your team and notifies you over Slack. DocFit never merges. Works with Mintlify, Docusaurus, Redocly/OpenAPI, MkDocs, Nextra, VitePress and plain Markdown, in the same repo or a separate docs repo. See real output without signing up: - the code PR: <a href="https://github.com/Docfit/example-payments-api/pull/1" target="_blank" rel="noreferrer nofollow">https://github.com/Docfit/example-payments-api/pull/1</a> - the docs PR DocFit opened: <a href="https://github.com/Docfit/example-payments-docs/pull/1" target="_blank" rel="noreferrer nofollow">https://github.com/Docfit/example-payments-docs/pull/1</a> Free for public repos and one private repo. During setup you can dry-run it on your last 5 merges and see what it would have changed. We're also looking for a few design partners with public/private API docs: Team plan free during early access, in exchange for honest feedback on the docs PRs. Reply here or email <a href="mailto:contact@docfit.dev" target="_blank" rel="noreferrer nofollow">contact@docfit.dev</a>. I'd love to hear any suggestions or feedback.

DocFit

Abhyudaya 2.0 was the second edition of Techno-Cultural fest organized by the Computer Science Department of Dayananda Sagar College of Engineering. Under this project, all kind of designs were made including logo, event poster certificates, banners, etc.

Abhyudaya 2.0

Ank is Newsletter published by the Department of Mathematics in Dayananda Sagar College Kumaraswamy of engineering. It contains details of all the events and activities conducted by the Department.

Ank : Magazine by Department of Mathematics

Ank is biannual newsletter published by Mathematics department of Dayananda Sagar College of Engineering. It showcases all the events, workshop, accomplishments, and publications by the department. This is the second issue of the magazine.

Ank 2: Newsletter by the Department of Mathem

Editor and designer of the first volume of Newsletter 'Ank' by Department of Mathematics.

Ank Newsletter

Developed an end-to-end website that contains information about more than 2000 3D printers. It was developed on python's Flask framework and includes features like search and sort filters based on various criteria. Implemented user creation and login, product details page with similar products gallery, and also developed an admin panel to customize various features and homepage. The website uses the MongoDB database and is deployed using GitLab.

MakeBase: 3D Printers Encyclopedia

Old School Tailor is an e-commerce website which sells premium shirts.

Old School tailor

Oncallservices is an IT consulting agency. We made Single page website for it.

OnCallServices

Designed and developed a static website using Hugo static website generator. The website includes a homepage, product search, product details, and perfume by filter pages. The website includes information about more than 50k perfumes