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

docs[cli]: fix display for code and typos #91

Merged
merged 3 commits into from Oct 5, 2022

Conversation

stanimirovv
Copy link
Contributor

The commands and example code inseveral places aren't displayed correctly on the website.

This PR will fix that.

Example:
image

Should be highlighted and displayed properlly with new lines and whitespace

@ivan-tymoshenko
Copy link
Member

Thanks for your PR. This page is generated automatically by https://github.com/platformatic/platformatic/blob/main/scripts/gen-cli-doc.mjs.

Please make sure that your changes won't be rewritten after cli changes.

@stanimirovv
Copy link
Contributor Author

Good point, I hadn't noticed that it is dynamically generated.
I will test and make adjustments if needed.

@stanimirovv
Copy link
Contributor Author

@ivan-tymoshenko oh yeah it is deffinetly overwridden.
I will apply the changes in a few hours and ping you when the PR is ready for rereview.

The ball is in my court :)

@stanimirovv
Copy link
Contributor Author

Changes are applied.

Copy link
Member

@ivan-tymoshenko ivan-tymoshenko left a comment

Choose a reason for hiding this comment

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

All txt files in the db/help are CLI help command output. The ideal solution would be to wrap inserts in the script.

I'm ok with markdown example annotations in the CLI output.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@mcollina mcollina merged commit 4da498d into platformatic:main Oct 5, 2022
@stanimirovv stanimirovv deleted the docs/improve-cli branch October 6, 2022 10:57
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.

None yet

3 participants