Skip to content

Backend Issues: Typo errors fixed, improved formatting, assets added #385

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

Merged
merged 6 commits into from
Jun 27, 2025

Conversation

mrdavidorok
Copy link
Collaborator

@mrdavidorok mrdavidorok commented Jun 8, 2025

Description

Provide a brief overview of what this documentation update is about. Explain what sections or topics are being added or revised.

Linear ticket and magic word Fixes DEVR-950

Type of change

  • Typo fix
  • New feature
  • Enhancement to current docs
  • Removed outdated references
  • Update assets

Writing & Tone

  • Use a neutral, instructional tone — avoid “I”, “we”, or “you should”.
  • All titles and headers must follow Title Case.
  • Avoid question-based titles and “How to…” phrasing.
  • Keep titles concise for SEO; avoid long or vague titles.
  • Use numbered bullet points for step-by-step instructions.
  • Avoid vague transitions like “Next” or “After that” — use clear numbered steps.
  • Do not use numbers in headings (e.g., ## 1. Check Settings is incorrect).

Code & Formatting

  • Use backticks () for inline code like User.providerData`.
  • Do not bold inline code or full code sentences.
  • Use fenced code blocks with correct language tags (e.g., json, jsx, bash).
  • Avoid combining bold and code formatting unnecessarily.

Admonitions (Notes, Warnings, Tips)

  • Use proper admonition syntax: :::note, :::tip, :::warning, etc.
  • Do not use “Pro Tip” in titles — the :::tip block already implies it.
  • Avoid bolding entire sentences — only bold keywords or labels when needed.
  • Do not add empty square brackets [] to admonition titles.

Linking

  • Bold linked keywords in context .
  • Never hyperlink vague words like “here” or “this document”.
  • Use relative links for internal docs (e.g., /integrations/firebase/...).
  • When referencing deployment, link directly to the mobile deployment doc.

Structure & Consistency

  • Follow this structure: Introduction → Prerequisites → Steps → Notes → Resources.
  • Match structure, tone, and formatting with existing FlutterFlow docs.
  • Format prerequisites using the standard :::info[Prerequisites] block.
  • Avoid repeating “in FlutterFlow” when it’s already implied.
  • Use consistent bullet and heading formatting across all articles.

File Naming & SEO

  • Do not use “issues” or “troubleshooting” in folder or slug names.
  • Use descriptive, action-based slugs (e.g., /fix-push-notification-permissions).
  • Slugs should be short, lowercase, and hyphenated.

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@mrdavidorok mrdavidorok marked this pull request as ready for review June 8, 2025 19:46
@github-actions github-actions bot requested a review from pinkeshmars June 8, 2025 19:46
@PoojaB26 PoojaB26 requested review from PoojaB26 and removed request for pinkeshmars June 16, 2025 14:59
Copy link
Collaborator

@PoojaB26 PoojaB26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please ensure titles are not questions and fix in other PRs as well.

Copy link
Collaborator

@PoojaB26 PoojaB26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are still getting the bullets vs numbered bullets issues, please read through them before finalizing the PR. Please check this in other PRs again.

@PoojaB26 PoojaB26 merged commit ff20228 into main Jun 27, 2025
1 check passed
@PoojaB26 PoojaB26 deleted the david/backend-issues branch June 27, 2025 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants