Docs style guide changes and improvements #503
Conversation
This makes it easier to refer people to specific guidelines within the guide.
Some places in the Dev and Sysadmin guides have deviated from this guideline and I think it's for the better. Examples: * https://docs.civicrm.org/dev/en/latest/framework/angular/ * https://docs.civicrm.org/sysadmin/en/latest/integration/drupal/views/
Use the terminology "Chapter/Sub-chapter/Page/Section" instead of "Part/??/Chapter/Section" because it's more intuitive.
totten
changed the title
|
I agree that 4 levels of menu can be needed for some topics. I was thinking I needed that extra level when planning the reorganisation of the email chapter. It makes no sense to have A/B testing at the second menu level as it is only relevant to CiviMail. so we need Email - Mass mailings using CiviMail - A/B testing I am not so keen on the nomenclature for the 4 levels. To me "page" doesn't fit. I think of a page as the place the information is displayed, not as a part of the content that is being displayed. This is obviously true for a physical book, but I think it also applies online where a page can have a heading, side bars etc. The content is just one part of it. However, having spent a couple of hours trawling on this topic, I can't find a definitive alternative. As it fits will how things are already described in the documentation guide so I am OK with it. |
|
Per discussion, this seems very sensible to me. Glad to have a definitive 1 - 1 relationship specified. Don |
|
Merging now since we've had a few opinions and discussed it at the meeting. https://lab.civicrm.org/documentation/docs/blob/master/meetings/notes/2018-04-03.md#style-guide |
Three distinct changes to the style guide, as described in each commit.
I'd like some feedback from these folks before continuing: