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

Lowcode docs: add link to YAML reference #21231

Merged
merged 1 commit into from
Jan 10, 2023
Merged

Conversation

sherifnada
Copy link
Contributor

@sherifnada sherifnada commented Jan 10, 2023

What

Adds a link to the YAML reference to the docs so users can always see the full options available.

In the future, it would be a better experience to have a CI hook which embeds this into the docs directly, using something like https://coveooss.github.io/json-schema-for-humans.

in the interest of "shipped is better than perfect", putting this here as a stopgap.

@sherifnada sherifnada marked this pull request as ready for review January 10, 2023 22:02
@octavia-squidington-iv octavia-squidington-iv added the area/documentation Improvements or additions to documentation label Jan 10, 2023
Copy link
Contributor

@lmossman lmossman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me for now. Want to create an issue for embedding the json in the docs directly?

@sherifnada
Copy link
Contributor Author

updated this issue's description #17398

@sherifnada sherifnada merged commit 09e4d99 into master Jan 10, 2023
@sherifnada sherifnada deleted the sherif/lowcode-ref-in-docs branch January 10, 2023 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants