Repository navigation
Add Messages Overview tab to Data Analytics docs - #684
Closed
rvignesh89 wants to merge 3 commits into
Closed
rvignesh89 wants to merge 3 commits into
rvignesh89 wants to merge 3 commits into
Conversation
/update-docs writes, refreshes, reviews and restructures docs against the live Glific app from a cloud env with playwright-cli preinstalled. - gdocs.mjs (zero-dep): preflight (env, CLI, browser, guard canary, redaction self-test, login), guarded session, redacted screenshots, blocked-write log, provenance/link lint - Network guard blocks mutations, lock-taking queries (flowGet, simulatorGet) and non-GET REST writes before login - Bash hooks restrict direct playwright-cli use to the guarded session and surface blocked writes so Claude stops and warns Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Move sections, style-writing, style-page and style-images into update-docs and remove the old documentation skill. - Header guidance now matches the <h3><table> block with Last Updated that most pages use, instead of the legacy ###** badge - Image guide requires gdocs shot; adds framing and filename-stability rules - Sections: _category_.json generated-index (not index.md), more routes - Refresh workflow accepts a glific-frontend PR as input Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Document the new Messages Overview tab (Messages Exchanged card, service message billing notice, Message Composition chart) and replace the intro screenshot with one showing all four tabs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
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. Comment |
|
🚀 Deployed on https://deploy-preview-684--glific-docs.netlify.app |
rvignesh89
added a commit
that referenced
this pull request
Oct 19, 2026
) ## Summary Adds the `update-docs` Claude Code skill (`/update-docs`). It writes, refreshes, reviews and restructures Glific docs. It checks the live production Glific app through a read-only `playwright-cli` browser session that redacts personal data from screenshots. It replaces the old `documentation` skill. **Skill: `.claude/skills/update-docs/`** - `scripts/gdocs.mjs` has no dependencies and does the following: - `preflight` checks the env vars, the CLI, the browser launch, a guard canary (a test write that must be blocked), a redaction self-test, and the login. - It manages a single guarded session. - `shot` takes redacted screenshots and records their hashes in a manifest. - `blocked` lists write requests the guard stopped. - `lint` checks image provenance, `/img/` refs and `.md` links. - Network guard: - It is installed before login. - It blocks every GraphQL mutation or subscription, and the queries that take edit locks (`flowGet`, `flowRelease`, `simulatorGet`, `simulatorRelease`). - It also blocks every other POST, PUT, PATCH or DELETE to the Glific host. - `scripts/pw-guard-hook.sh` (Bash pre/post hooks): - Direct `playwright-cli` calls must use the guarded session and an allow-listed set of commands. - When a write is blocked, the hook warns Claude so it stops and tells the user. - Workflow guides for refresh, new page, review and restructure, plus `browsing.md` and `safety.md`. **Style guides moved over from the old `documentation` skill** - `sections`, `style-writing`, `style-page` and `style-images` now live in `update-docs`, and `.claude/skills/documentation/` is removed. - The header guidance now matches the `<table>` block with Last Updated that most pages use. - The image guide requires `gdocs shot` and adds rules for framing and keeping filenames stable. - The refresh workflow accepts a glific-frontend PR as input. **Other** - `.gitignore`: ignore `.playwright-cli/` (session output, snapshots, redaction manifest). ## Notes - This replaces #684, which also included a Data Analytics page change. That change is reverted on this branch (ff469fe, then c6d7397), so the diff against `main` contains only the skill. - How it was tested: the skill ran end to end in a cloud session. - Preflight passed. - The guard blocked writes, including one the app sends on its own (marking messages as read). - Lint passed. - Screenshots came out redacted. - Environment requirements: `GLIFIC_URL`, `GLIFIC_PHONE`, `GLIFIC_PASSWORD`, `playwright-cli` with a matching Chromium, and `moonshine.projecttech4dev.org` in the allowed domains so the analytics dashboard loads. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G --- _Generated by [Claude Code](https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G)_ <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a guided workflow for creating, updating, reviewing, and restructuring documentation, with standards for writing, page structure, and images. * Added safeguards for browsing the live app and capturing redacted screenshots. * Removed the previous documentation guidance files. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Data Analytics dashboard now has four tabs, but the docs listed only three. This PR documents the missing Messages Overview tab, based on the live production dashboard.
docs/4. Product Features/Data Analytics.mdNew images (
static/img/analytics/), taken with the redactinggdocs shot: the staff name is redacted, and the rest shows only aggregate counts.analytics_dashboard_tabs.pnganalytics_messages_overview.pngNotes
update-docsskill commits that aren't onmainyet (c614abf, fc6d792).gdocs lintpasses.node_moduleswasn't installed locally, so CI will run the Docusaurus build.🤖 Generated with Claude Code
https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G
Generated by Claude Code