Skip to content

Conversation

@vicb
Copy link
Contributor

@vicb vicb commented Oct 14, 2024

Summary

fix formatting

Documentation checklist

@vicb
Copy link
Contributor Author

vicb commented Oct 17, 2024

@cloudflare/workers-docs @cloudflare/pcx-technical-writing can this be merged?

@pedrosousa
Copy link
Contributor

Hi @vicb
Actually, we're now using prettier on file save and we're using tabs to indent code blocks (also done by prettier). I'll give it one last pass locally to update the file, which will fix the indentation as you intended.

@vicb
Copy link
Contributor Author

vicb commented Oct 17, 2024

Hey @pedrosousa,

Thanks for your help.

I have a few questions for you:

Actually, we're now using prettier on file save

Using prettier is great - there are a lot of inconsistencies in the docs.

Why don't we format all the docs with that instead of doing it only on file save?

It would require to update the format script to include md and mdx files.

We would also probably need to add a few ignored folders.

I don't see any blockers on doing that and we would have a consistent formatting.

If the whole docs are formatted some PR might get merge conflicts but it would be easy to format them to remove the conflicts. I can help with that if needed.

Let me know what you think, is this has been discussed already or if I need to create a feature request.

The second question is to understand how PRs are merged in this repo. This PR is now approved, when will it get merged?
I have another PR that is waiting to be merged. No rush, I only want to understand the workflow here.

Thanks.

@pedrosousa
Copy link
Contributor

pedrosousa commented Oct 17, 2024

The use of prettier is definitely not consistent. We're checking internally whether our config is the best one (prettier can be a bit finicky with MD/MDX + tabs) and how we would approach a more global update.

I'll merge the PR now that the checks have finished.

Usually the assigned tech writer handles the review and the merge, but this may take a few days. Other internal folks with write access can also approve and merge PRs (usually when they're smaller or urgent).

@pedrosousa pedrosousa merged commit 692e949 into cloudflare:production Oct 17, 2024
7 checks passed
@vicb vicb deleted the patch-2 branch October 17, 2024 09:51
@vicb
Copy link
Contributor Author

vicb commented Oct 17, 2024

Thanks @pedrosousa!

We're checking internally whether our config is the best one (prettier can be a bit finicky with MD/MDX + tabs) and how we would approach a more global update.

Let me know if there is anything I can help with here. Inconsistencies are bothering me so I would love to help unblock a global update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants