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

docs: added a docs convention #1014

Merged
merged 6 commits into from
Nov 28, 2023

Conversation

Jaskowicz1
Copy link
Contributor

This PR adds a docs convention, as discussed for a while now. If you have anything you want adding to this page, please feel free to say! I want to make sure we're catching most, if not everything, for docs here.

Documentation change checklist

  • My documentation changes follow the same style as the rest of the documentation and any examples follow the coding style guide.
  • I tested that my change works before raising the PR (via running doxygen, and testing examples).
  • I have not moved any existing pages or changed any existing URLs without strong justification as to why.
  • I have not generated content using AI or a desktop utility such as grammarly.

@Jaskowicz1 Jaskowicz1 self-assigned this Nov 26, 2023
Copy link

netlify bot commented Nov 26, 2023

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 7c40d72
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/6564e7c68c4a7f00083a04a1
😎 Deploy Preview https://deploy-preview-1014--dpp-dev.netlify.app/docs-standards
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 26, 2023
@braindigitalis braindigitalis merged commit f94812c into brainboxdotcc:dev Nov 28, 2023
12 checks passed
@Jaskowicz1 Jaskowicz1 deleted the docs-convention branch June 13, 2024 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants