Commit Docs

[sumitjain236]

Commit Docs is a documentation platform that supports MDX for combining Markdown and JSX. The focus is on intuitive navigation and a great user experience with flexible content creation, customizable navigation, and publishable content.

The idea is that users can connect their docs with their codebase; if they want to treat it as normal docs, they can do that.
Our documentation integrates directly with the codebase, exporting content into the file structure. This setup allows team members and contributors to easily add updates and create pull requests for any changes, making documentation contributions seamless and reviewable.

Using Commit, users can utilize APIs for an API explorer, even ERDs for better understanding of docs.

CheckList

• Allow User to Publish Docs from Commit (API explorer)

• Commit Docs Architecture (Include Footer, Navbar and Sidebar Structure).
• Sidebar Can have nested Groups

• Allow User to Set Icons for Sidebar or Navbar Items (Dynamic Icons Import) - Support Only React Icons

• Create User Friendly Design / UI for Docs Site

• Research About MDX https://mdxjs.com/
• Implement MDX in Docs
• Provide Some Shortcut Keys or Options for Heading , Bold etc.
• Connect the docs with Codebase
• Sync Database with docs Codebase