Skip to content

docs: refresh guidance after v1.0.0 release - #481

Merged
electrohyun merged 1 commit into
mainfrom
docs-refresh-post-v1-guidance
Sep 3, 2026
Merged

docs: refresh guidance after v1.0.0 release#481
electrohyun merged 1 commit into
mainfrom
docs-refresh-post-v1-guidance

Conversation

@electrohyun

@electrohyun electrohyun commented Sep 3, 2026

Copy link
Copy Markdown
Owner

Summary

Update the English and Korean contributor guidance now that v1.0.0 is published. Current work points to the issue tracker and milestones instead of the completed v1 tracker.

Reframe the roadmap around the stable compatibility boundary and recurring release gates. README navigation and the adapter guide now describe v1.0.0 as completed history, while the historical decision records remain unchanged.

Related issue

None.

Checklist

  • Tests added or updated — not applicable; existing documentation checks cover this change
  • Behavior verified against real socket.io — not applicable; runtime behavior is unchanged

@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
smocket Ready Ready Preview Sep 3, 2026 2:55am UTC

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

Important

  • No files to review - (🔄 Check again to try again)

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 3bc87e91-9aa0-4aec-8263-a6b0204c716f

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 8b6b3074-f700-4b3b-a830-312fdaa73d0c

📥 Commits

Reviewing files that changed from the base of the PR and between 4d6f1b4 and 2fc94f9.

📒 Files selected for processing (8)
  • CONTRIBUTING.ko.md
  • CONTRIBUTING.md
  • README.ko.md
  • README.md
  • docs/README.md
  • docs/adapter-registration.md
  • docs/development-lenses.md
  • docs/roadmap.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation now reflects smocket’s v1.0.0 stable release. It updates contributor guidance, roadmap terminology, release tracking links, and related documentation references.

Changes

Stable release documentation

Layer / File(s) Summary
Stable roadmap and release tracking
docs/roadmap.md
The roadmap now defines the stable boundary, release gates, validation paths, post-v1.0.0 additions, and current tracking links.
Contributor status and compatibility guidance
CONTRIBUTING.md, CONTRIBUTING.ko.md
The contributor guides state that v1.0.0 was reached in August 2026 and reference decision 0019 for public API and documented behavior compatibility.
Documentation terminology and rationale
README.md, README.ko.md, docs/README.md, docs/adapter-registration.md, docs/development-lenses.md
Documentation links and explanatory text now use stable-release terminology and describe the adapter seam as part of the stable public surface.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 2fc94

This updates release-status, compatibility, roadmap, and navigation language to reflect the completed v1.0.0 release. The documented guidance is consistent across the reviewed English and Korean entry points, with no runtime impact.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the documentation update after the v1.0.0 release.
Description check ✅ Passed The description directly explains the documentation updates, roadmap reframing, completed v1.0.0 references, and unchanged runtime behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (8 skipped: 8 unsupported.)


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.

@github-actions github-actions Bot added documentation Improvements or additions to documentation 📏 m Pull request changes 50–199 lines labels Sep 3, 2026
@electrohyun
electrohyun force-pushed the docs-refresh-post-v1-guidance branch from 2fc94f9 to 0a04f11 Compare September 3, 2026 02:55
@electrohyun
electrohyun merged commit 0d3ea2c into main Sep 3, 2026
19 checks passed
@electrohyun
electrohyun deleted the docs-refresh-post-v1-guidance branch September 3, 2026 02:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation 📏 m Pull request changes 50–199 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant