Skip to content

Conversation

@VinitaSilaparasetty
Copy link

What

  • Add scripts/generate-schema-docs.ts: TypeScript generator that produces a single, human-readable Markdown page from local JSON Schemas (project, collection).
  • Output: docs/oss-directory-schema.md.
  • No runtime deps; run via npx tsx.

Why

  • Improves readability over default generators (clear titles, array handling, examples, constraints).
  • Keeps docs tied to the source schemas; re-generate after schema changes.

How to run

  • npx tsx scripts/generate-schema-docs.ts

References

@VinitaSilaparasetty
Copy link
Author

@ryscheng @ravenac95 I gave it another go, this time with a simpler solution. I'm grateful for any feedback that you can provide.

@VinitaSilaparasetty
Copy link
Author

Thanks to @ryscheng for reviewing this. Based on our subsequent discussion regarding project scope and the current roadmap, I'm going to close this for now. Thanks again for your time and feedback.

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.

1 participant