Repository navigation
docs: rewrite the README for visitors and add community files - #46
Merged
Merged
Conversation
Rewrite the README for people discovering Sinew: what it solves, a status note, a Kotlin and Dart code example checked against the real APIs, features, platforms, trying it from source before 1.0, and links to both docs sites. The docs deployment and build details move to CONTRIBUTING.md. Add CODE_OF_CONDUCT.md (the Contributor Covenant 2.1 text the libraries already use), SECURITY.md (private reporting through GitHub security advisories, per repository) and .github/CODEOWNERS, and link them from CONTRIBUTING.md and the README. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 21, 2026
dwikiriyadi
added a commit
to srctool/sinew-kotlin
that referenced
this pull request
Oct 21, 2026
## What Replaces the stale "Status: milestone **S0** (skeleton)" line in the README with the current state: - **Implemented:** every package through testing - **In progress:** the Camouflage glue and the sample list screen - **Planned for 1.1:** DevTools It also links the roadmap. ## Why The umbrella README ([srctool/sinew#46](srctool/sinew#46)) now describes Sinew as pre-1.0 with these packages implemented; this README said the opposite. Opened together with the matching sinew-dart PR. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
dwikiriyadi
added a commit
to srctool/sinew-dart
that referenced
this pull request
Oct 25, 2026
## What Replaces the stale "Status: milestone **S0** (skeleton)" line in the README with the current state: - **Implemented:** every package through testing - **In progress:** the Camouflage glue and the sample list screen - **Planned for 1.1:** DevTools It also links the roadmap. The `sinew_security` row no longer says it \"becomes a plugin with native code at S4\"; it is one now. ## Why The umbrella README ([srctool/sinew#46](srctool/sinew#46)) now describes Sinew as pre-1.0 with these packages implemented; this README said the opposite. Opened together with the matching sinew-kotlin PR. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
What
processApiCall→ view model) in Kotlin, with Dart in a collapsible section; checked against the real APIssinew-kotlinandsinew-dartalready use, at the root so GitHub detects it for this repo.@dwikiriyadias owner, with separate rules fordocs/,.github/and the submodule pointers.Why
The repository didn't read like an open-source project: the README covered deployment and secrets but had no example, status or install path, and the root had no Code of Conduct, security policy or code owners.
To check
sinew_securityplugin declares only those).Follow-ups (not in this PR)
sinew-kotlinandsinew-dartREADMEs still say "Status: milestone S0".🤖 Generated with Claude Code