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

Improve markdown output so we can import it on stellar docs. #1435

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

fnando
Copy link
Member

@fnando fnando commented Jul 5, 2024

What

Improve markdown output so we can import it on stellar docs.

Why

The idea is importing the FULL_HELP_DOCS.md file from the stellar docs build pipeline, so we always have the latest output.

Known limitations

N/A

Copy link
Contributor

@chadoh chadoh left a comment

Choose a reason for hiding this comment

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

Why draft? Looks great!

@chadoh
Copy link
Contributor

chadoh commented Jul 8, 2024

Oh, but when did we stop putting this in the docs directory with the helpful README.md that said "AUTOGENERATED, DON'T EDIT DIRECTLY"?

@leighmcculloch
Copy link
Member

Oh, but when did we stop putting this in the docs directory with the helpful README.md that said "AUTOGENERATED, DON'T EDIT DIRECTLY"?

I think I moved it out of the directory when I was removing things from the repo not being used. It felt like the type of doc that would live well at the top-level, and the doc already has at the bottom a note saying it's automatically generated. Although it looks like @fnando is removing that footer message.

I wouldn't be too worried about someone accidentally editing it because CI should quickly block someone from merging an out of sync help doc.

@fnando
Copy link
Member Author

fnando commented Jul 10, 2024

Although it looks like @fnando is removing that footer message.

I am, because we're going to use the file directly on stellar/stellar-docs, and it wasn't rendering well.

@fnando fnando marked this pull request as ready for review July 10, 2024 12:07
@fnando fnando enabled auto-merge (squash) July 10, 2024 12:25
@fnando fnando merged commit 13d0ee6 into main Jul 10, 2024
24 of 25 checks passed
@fnando fnando deleted the update-markdown-docs branch July 10, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants