refactor: restructure project layout and documentation#39
Merged
Conversation
Teingi
commented
Jun 3, 2026
Teingi
commented
Contributor
- Rename files to snake_case for PEP 8 compliance (Interal_watch → internal_watch, capTaskQueues → cap_task_queues, etc.)
- Move tests from scl/test/ to tests/ per standard project layout
- Remove stale files: test.py (otel experiment), requirements.txt (uv export artifact)
- Move test.sh into scripts/ directory
- Rewrite doc/ with structured documentation (overview, architecture, core concepts, getting started, SDK reference, development roadmap)
- Rewrite README.md and README_CN.md to match open-source standards
- Update Dockerfile to install from pyproject.toml instead of requirements.txt
- Update Makefile lock target to drop requirements.txt export
- Update .dockerignore to allow README.md into build context
- Add missing config files: .gitignore, .env.example, .pre-commit-config.yaml
- Rename files to snake_case for PEP 8 compliance (Interal_watch → internal_watch, capTaskQueues → cap_task_queues, etc.) - Move tests from scl/test/ to tests/ per standard project layout - Remove stale files: test.py (otel experiment), requirements.txt (uv export artifact) - Move test.sh into scripts/ directory - Rewrite doc/ with structured documentation (overview, architecture, core concepts, getting started, SDK reference, development roadmap) - Rewrite README.md and README_CN.md to match open-source standards - Update Dockerfile to install from pyproject.toml instead of requirements.txt - Update Makefile lock target to drop requirements.txt export - Update .dockerignore to allow README.md into build context - Add missing config files: .gitignore, .env.example, .pre-commit-config.yaml Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Standardize on 'docs/' as the documentation directory name, consistent with GitHub Pages and open-source conventions. Update all internal references in README, README_CN, docs/06-development.md, and .dockerignore. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Replace top-level imports of LocalEmbeddingClient and WebEmbeddingClient with lazy imports inside CompositeEmbedding.__init__ - Replace hasattr(config, ...) with getattr + bool so unset config values don't activate optional backends - This fixes ModuleNotFoundError for sentence-transformers when the [local] extra is not installed Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
SamYuan1990
requested changes
Jun 3, 2026
| name = "structured-context-language" | ||
| description = "Structured Context Language (SCL) — a standardized agent loop runtime for context engineering." | ||
| readme = "README.md" | ||
| requires-python = ">=3.11" |
Collaborator
There was a problem hiding this comment.
please change to python 3.9
Collaborator
There was a problem hiding this comment.
I suppose it's a question for us, do we need an install option for local embedding or not?
Collaborator
|
In general the PR is great, leave question to discuss before merge. |
SamYuan1990
approved these changes
Jun 4, 2026
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.