Skip to content

chore: setup markdownlint for consistent documentation standards#518

Merged
ritesh-1918 merged 19 commits into
ritesh-1918:gssocfrom
unsiqasik:chore/setup-markdownlint
May 29, 2026
Merged

chore: setup markdownlint for consistent documentation standards#518
ritesh-1918 merged 19 commits into
ritesh-1918:gssocfrom
unsiqasik:chore/setup-markdownlint

Conversation

@unsiqasik
Copy link
Copy Markdown

Summary

Adds markdownlint configuration to enforce consistent documentation standards across the project.

Changes

  • .markdownlint.json: Comprehensive markdownlint rules configuration
    • Line length limit (120 chars)
    • Consistent heading styles (ATX)
    • Proper list formatting
    • Code block formatting
    • Link and image validation

Benefits

  • Consistent documentation style across all contributors
  • Catch common markdown errors early
  • Can be integrated with CI/CD pipeline
  • Works with VS Code markdownlint extension
  • Improves documentation quality and readability

Integration

Add to your CI/CD pipeline:

- name: Lint Markdown
  uses: DavidAnson/markdownlint-cli2-action@v9

Closes #217

namann5 and others added 19 commits May 22, 2026 11:30
- Replace raw user_id with SHA256 hash (8-char prefix) in all log statements
- Maintains audit trail capability while protecting user identifiers (PII)
- Complies with GDPR/CCPA privacy requirements
- Hash is deterministic for correlation without exposing PII

Resolves CodeRabbit PII logging concern
…backfill

Fix tenant ticket orphaning by persisting company_id on save
…ashboard

feat: Real-time Support Dashboard Updates Using Supabase Realtime Channels
- Add .markdownlint.json with comprehensive rules
- Configure line length, heading styles, list formatting
- Ensure consistent markdown across all documentation
- Follows markdownlint best practices

Closes ritesh-1918#217
@vercel
Copy link
Copy Markdown

vercel Bot commented May 28, 2026

@zeroknowledge0x is attempting to deploy a commit to the ritesh Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Warning

Review limit reached

@unsiqasik, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 22 minutes and 29 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2d79fd35-5b4f-4a30-b114-554c6ff94d4a

📥 Commits

Reviewing files that changed from the base of the PR and between fb6a950 and 805758d.

📒 Files selected for processing (1)
  • .markdownlint.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ritesh-1918 ritesh-1918 changed the base branch from main to gssoc May 29, 2026 19:26
@ritesh-1918 ritesh-1918 added gssoc GirlScript Summer of Code gssoc:approved GSSoC Approved PR level:advanced Advanced level difficulty quality:exceptional Exceptional code quality type:feature New feature labels May 29, 2026
@gitguardian
Copy link
Copy Markdown

gitguardian Bot commented May 29, 2026

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
29368972 Triggered Supabase Service Role JWT b460068 scratch/test_companies.js View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@ritesh-1918
Copy link
Copy Markdown
Owner

Hi @unsiqasik! Thanks for the contribution. I have successfully converted your PR's target branch to gssoc to keep our codebase unified.

PR approved and merged! Welcome to the family! 🚀💻


🌟 Developer Action Network

Before starting or submitting updates, please complete these quick onboarding steps:

  1. Star this repository: https://github.com/ritesh-1918/HELPDESK.AI
  2. 👤 Follow the Project Admin: https://github.com/ritesh-1918
  3. 💼 Connect on LinkedIn: https://www.linkedin.com/in/ritesh1908/

Note: All PR branches must target the gssoc branch, NOT main.

@ritesh-1918 ritesh-1918 added the level:critical Critical level difficulty label May 29, 2026
@ritesh-1918 ritesh-1918 merged commit 9f2543f into ritesh-1918:gssoc May 29, 2026
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved GSSoC Approved PR gssoc GirlScript Summer of Code level:advanced Advanced level difficulty level:critical Critical level difficulty quality:exceptional Exceptional code quality type:feature New feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Chore: Setup markdownlint to enforce consistent documentation standards

5 participants