operator icon indicating copy to clipboard operation
operator copied to clipboard

docs: update style guide

Open IronCore864 opened this issue 10 months ago • 5 comments

Add more doc style guide.

The STYLE.md in the Pebble repo also links to here.

IronCore864 avatar May 07 '25 12:05 IronCore864

@IronCore864 @dwilding I'm not sure about this change. Ops is kind of Charm Tech's "main" repo, so it seems to me if anywhere, the docs style guide should belong there. If there's disagreement, seeing it's almost the engineering sprint, perhaps we can discuss and finalise next week? I've added to our discussion list.

benhoyt avatar May 08 '25 09:05 benhoyt

I agree that the ops repo is the "main" one. Although all the examples in the doc guide are from Pebble, I don't think it's a big problem, because they are all examples, so it's OK for them to live in the ops repo. I don't have a strong feeling about it.

IronCore864 avatar May 09 '25 08:05 IronCore864

Same - I'm good if the doc guidance goes in Ops instead of Pebble.

dwilding avatar May 09 '25 08:05 dwilding

Sounds good -- let's do that then. We may want to tweak some of the "obviously Pebble" examples to be more Ops-y, but we can cover that in review.

benhoyt avatar May 09 '25 09:05 benhoyt

Adding Tony, while Ben is away. The docs LGTM :)

dimaqq avatar Jun 24 '25 04:06 dimaqq

Updated and fixed all suggestions in the comments. Merging now.

IronCore864 avatar Jul 01 '25 04:07 IronCore864