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.

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

Support for docs/config.json #403

Open
pvande opened this issue Oct 21, 2024 · 0 comments
Open

Support for docs/config.json #403

pvande opened this issue Oct 21, 2024 · 0 comments

Comments

@pvande
Copy link

pvande commented Oct 21, 2024

Proposal: Add support for docs/config.json as a valid configuration endpoint, in addition to docs.json and docs.yaml.

Rationale: Allows all documentation-related files to live under docs, providing better encapsulation. This also allows generated documentation to remain self-contained, which can be an advantage to that build process.

Potential Drawbacks: Adding another configuration file location weakens the convention overall, and potentially opens the doors to additional conversations in the future (e.g. docs/config.yaml?). Adds an additional API test when looking for configuration.

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

No branches or pull requests

1 participant