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

Writing style guide doesn't match company writing style guide #473

Closed
GuySartorelli opened this issue Mar 11, 2024 · 3 comments
Closed

Writing style guide doesn't match company writing style guide #473

GuySartorelli opened this issue Mar 11, 2024 · 3 comments

Comments

@GuySartorelli
Copy link
Member

The writing style guide for Silverstripe CMS docs doesn't include everything from the company style guide in confluence.
There is a chance there are conflicts between the two, as well.

To decide

  • To what extent do the docs need to follow the company style guide?
    • Take into account that the company style guide has changed and may change again outside of our control
      • keeping the docs up to date with those changes may be difficult
      • We ideally don't want to update the style guide for new docs, which then end up reading completely different from existing docs.
@michalkleiner
Copy link
Contributor

As much as everyone appreciates the company's contribution to the project I think certain things could/should be independent and it should be the OS CMS hat to wear first ;-)

@GuySartorelli
Copy link
Member Author

I 10000% agree. This card came about because of #472 which says to use the company style guide.

@GuySartorelli
Copy link
Member Author

#302 is bringing some parity between the two - I think we can all agree to put this to rest once that's finished and merged, and just use the publicly documented style guide henceforth.

@GuySartorelli GuySartorelli closed this as not planned Won't fix, can't repro, duplicate, stale May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants