Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generated Documentation #41

Open
philsturgeon opened this issue Dec 29, 2022 · 1 comment
Open

Generated Documentation #41

philsturgeon opened this issue Dec 29, 2022 · 1 comment

Comments

@philsturgeon
Copy link
Contributor

Use Story

As a user of this style-guide, I'd love to be able to see the rules explained somewhere properly with their descriptions expanded, so I know what I'm getting any why.

Details

There's no open-source automatic documentation generation tool for Spectral currently, but I think I can import it into Stoplight Platform to get something built for me.

As I think @mnaumanali94 has already done the import lets see if there's a public link I can use for this.
@dphuang2
Copy link

+1 for a Spectral Ruleset -> Markdown tool! We could definitely use this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@philsturgeon @dphuang2