You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We expect to be doing a fair bit of documentation over the next couple months. It would be helpful to agree on some common best practices when drafting doc.
Acceptance criteria
Liaise with the Silverstripe Content Writer upfront to make sure the guide lines line ups with Silverstirpe other style guide.
Existing documentation best practices are reviewed.
New best practices are agreed upon.
Validate if the generic style guide should apply to the doc and make sure relevant rules are available to the public.
Notes
This should not encompass docblock in our PHP code. We will spin up a separate card for it.
maxime-rainville
changed the title
Review best practice developer doc
Review best practice for drafting documentation in the developer docs
Sep 3, 2023
We expect to be doing a fair bit of documentation over the next couple months. It would be helpful to agree on some common best practices when drafting doc.
Acceptance criteria
Liaise with the Silverstripe Content Writer upfront to make sure the guide lines line ups with Silverstirpe other style guide.Notes
Related
PRs
The text was updated successfully, but these errors were encountered: