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

Review best practice for drafting documentation in the developer docs #302

Closed
maxime-rainville opened this issue Jul 20, 2023 · 1 comment
Assignees

Comments

@maxime-rainville
Copy link
Contributor

maxime-rainville commented Jul 20, 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.
  • 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.

Related

PRs

@maxime-rainville maxime-rainville changed the title Review best practice developer doc Review best practice for drafting documentation in the developer docs Sep 3, 2023
@emteknetnz emteknetnz self-assigned this Apr 10, 2024
@GuySartorelli
Copy link
Member

PR merged.

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

3 participants