docs: describe WordyMe as a self-hosted personal wiki - #106
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughWordyMe’s product messaging now describes a self-hosted personal wiki and note-taking application across documentation, Docker publishing workflows, and web metadata. ChangesProduct positioning
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 15: Update the descriptive phrase “Next Generation ERP Solution” to
“next-generation ERP solution” in the README, unless it is confirmed to be the
official product name.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d989bba3-8df8-49cd-bc0c-7a668ffbbd45
📒 Files selected for processing (7)
.github/workflows/release-publish.yml.github/workflows/verify-publishing.ymlCONTRIBUTING.mdDOCKERHUB.mdREADME.mdapps/web/index.htmlapps/web/vite.config.ts
AdminTeamCoderz
force-pushed
the
docs/reposition-personal-wiki
branch
from
August 10, 2026 11:17
4e52ddd to
1d59412
Compare
The public copy still described a platform for students managing educational information — positioning the product has moved away from, and which was inconsistent across four different places: the README, the Docker Hub page, the page meta description, and the PWA manifest. Two of those are the ones people actually see first, since the meta description feeds search results and link previews, and the image label ships inside every published release. "Personal wiki" is deliberate rather than "wiki": signup is only available while the database has no users, so an instance holds exactly one account. The qualified term reaches people searching for a wiki without promising collaboration the product does not have. Copy only — no behavior changes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AdminTeamCoderz
force-pushed
the
docs/reposition-personal-wiki
branch
from
August 10, 2026 11:21
1d59412 to
b7344a1
Compare
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
1 participant
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 public copy still described WordyMe as "a centralized platform for students to manage educational information" — positioning the product has moved away from. Worse, the wording was inconsistent across four places that each reach a different audience, and two of them are the first thing anyone sees: the page meta description (what search engines index and what every shared link preview shows) and the OCI image label, which is baked into every published release. This replaces the education framing everywhere with one consistent description.
"Personal wiki" is deliberate, not a synonym for "wiki." Signup is only available while the database has no users (
apps/backend/src/lib/auth.ts:23), so an instance holds exactly one account. The qualified term reaches people searching for a self-hosted wiki without promising collaboration the product does not offer — the unqualified word would attract users who would install it, find no way to add a teammate, and leave.Related Issues
None — follow-up to the WordyMe branding work.
Fixes # — n/a
Type of Change
Documentation / copy. No behavior changes.
Changes
README.md— opening description rewritten; the mission line no longer references educational tools; the PRO paragraph now addresses "organizations" rather than "institutions", which read as schools.DOCKERHUB.md— headline and opening paragraph rewritten (this is the Docker Hub landing page).CONTRIBUTING.md— the "Make an impact" line and the Open Core paragraph no longer reference students or institutions.apps/web/index.html— meta description: "Your own private wiki. Self-hosted notes and documentation, light enough to run on a Raspberry Pi."apps/web/vite.config.ts— PWA manifest description matched to the same line..github/workflows/release-publish.yml— theorg.opencontainers.image.descriptionlabel (3 occurrences, one per build target) and the Docker Hub short description..github/workflows/verify-publishing.yml— the same short description, kept in sync.Deliberately left alone:
'school'/'university'inicon-picker.tsx(icon names users choose from, not copy), and the "campus NAT" examples in the Docker docs (technical illustrations of shared-IP rate limits).How to Test
pnpm --filter web build, then confirm the new line appears indist/index.html(meta description) anddist/manifest.webmanifest(description).grep -ri "student\|educational\|edtech" --include="*.md" --include="*.html" --include="*.yml" .(excludingnode_modules,dist) returns nothing.README.mdandDOCKERHUB.mdtop-to-bottom — the description reads consistently in both.org.opencontainers.image.descriptionlabel and the Docker Hub short description update automatically.Expected result: one description, used everywhere; no education framing left in public copy.
Screenshots
Not a UI change — section not applicable.
Summary by CodeRabbit
Documentation
Chores