Skip to content

docs: add Ecosystem section to README - #22

Merged
bcdxn merged 1 commit into
bcdxn:mainfrom
bhouston:feature/readme-ecosystem
Sep 22, 2026
Merged

bcdxn merged 1 commit into
bcdxn:mainfrom
bhouston:feature/readme-ecosystem

Conversation

@bhouston

Copy link
Copy Markdown
Contributor

Adds an Ecosystem section to the README listing community projects built on the spec, starting with clidoc: TypeScript adapters for Yargs, Commander, and oclif that emit OpenCLI documents, plus validation, Markdown output for Docusaurus/VitePress, an MCP server, and a GitHub Action for CI validation.

Also adds the section to the table of contents and invites other projects to add themselves.

Co-Authored-By: Claude <noreply@anthropic.com>
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bcdxn

bcdxn commented Sep 22, 2026

Copy link
Copy Markdown
Owner

Love the idea! thanks for the contribution. I see you support docs generation for oclif and commander in addition to Yargs. Since OpenCLI doesn't yet have support for these frameworks, I might look to port some of your logic back into OpenCLI if that's ok with you.

@bhouston

Copy link
Copy Markdown
Contributor Author

Since OpenCLI doesn't yet have support for these frameworks, I might look to port some of your logic back into OpenCLI if that's ok with you.

OpenCLI does now have support for these frameworks in my project clidoc: https://clidoc.dev What you do mean it doesn't have support?

Instead of just copying my work into your project, could we work together? I am trying to support this specification in the node ecosystem as I had a similar idea? Why would you undermine that work by just replicating it in this project?

@bhouston

bhouston commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor Author

The opencli term is over used and there are 3 different projects with that name. There are no other npm packages called clidoc and it matches the tsdoc and jsdoc toolsets in the JavaScript/TypeScript work. It is a good name for this in the JavaScript/TypeScript ecosystem.

I am always the top hit for clidoc apparently in google.

@bcdxn

bcdxn commented Sep 22, 2026

Copy link
Copy Markdown
Owner

Didn't mean to offend! I think it's great that you're building the TypeScript/Node ecosystem around the spec.

This repo houses the spec but also the ocli CLI to generate code and docs. So when I said "OpenCLI doesn't support... " I mean the ocli CLI published from this repository. My thought was that your implementation might give me some ideas for adding some code gen support to those other frameworks in ocli, not that I'd just be duplicating clidoc functionality.

@bcdxn
bcdxn merged commit 2606dfe into bcdxn:main Sep 22, 2026
3 checks passed
@bcdxn

bcdxn commented Sep 22, 2026 •

Copy link
Copy Markdown
Owner

@bhouston - would you want to give a backlink to https://opencli.dev/specification on your site? And I can create an ecosystem page on opencli.dev as well to link to clidoc https://clidoc.dev. I do appreciate that you already link to this repo from your README.

@bhouston

Copy link
Copy Markdown
Contributor Author

I've created an ecosystem page on https://clidoc.dev that points to your website!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants