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

[BD-3275] Developer guide overhaul #8078

Draft
wants to merge 15 commits into
base: develop
Choose a base branch
from
Draft

[BD-3275] Developer guide overhaul #8078

wants to merge 15 commits into from

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Sep 13, 2024

Summary

Work in progress for the developer guide overhaul. FYI its gonna get messy in here, but I don't want to accidentally loose my work, so I'm pushing to the cloud.

Note: There's a chance that this PR never gets merged since it will probably have a million conflicts lol. Instead, this PR may simply house all changes, then we can just copy+paste smaller chunks of work into separate PRs to do a rolling release. If that's the case, the first step should be to "uniform-ize" all the developer guide sections (i.e. uniform folder/file names, uniform folder/file locations, uniform headings and other yaml frontmatter, etc.) before combining sections together.

TODO

  • Add list here...

Related PRs, issues, or features (optional)

Feature release date (optional)

  • N/A

Contributor checklist

  • I confirm that my PR meets the following:
    • I signed the Contribution License Agreement (CLA).
    • My style and voice follows the Braze Style Guide.
    • My content contains correct spelling and grammar.
    • All links are working correctly.
    • If I renamed or moved a file or directory, I set up URL redirects for each file.
    • If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see Updating an image).
    • If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal.

Submitting for review

If your PR meets the above requirements, select Ready for review, then add a reviewer:

  • Non-Braze contributors: Add braze-inc/docs-team as the reviewer.
  • Braze employees: Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the tech writer assigned to your specific vertical. If you're not sure which tech writer to add, you can add braze-inc/docs-team instead.

Thanks for contributing! We look forward to reading your work.

@internetisaiah internetisaiah self-assigned this Sep 13, 2024
@cla-bot cla-bot bot added the cla-signed label Sep 13, 2024
@internetisaiah internetisaiah added the status: do not merge Could mean research before "in progress" status, or do not merge yet. label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed status: do not merge Could mean research before "in progress" status, or do not merge yet.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants