Skip to content

[WIP] Update documentation for project#11

Merged
huangyiirene merged 5 commits intomainfrom
copilot/update-documentation
Jan 13, 2026
Merged

[WIP] Update documentation for project#11
huangyiirene merged 5 commits intomainfrom
copilot/update-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 13, 2026

Documentation Update Complete ✅

Successfully updated all documentation to reflect the current package structure:

Changes Made

Main Documentation

  • Update main README.md to reflect current packages
  • Update docs/guide/installation.md with current installation instructions
  • Update docs/guide/introduction.md with current package names
  • Update docs/spec/project-structure.md to match actual structure
  • Update docs/spec/architecture.md with current layer structure
  • Update docs/protocol/overview.md with correct package references

API Documentation

  • Update docs/api/core.md to reflect @object-ui/core package
  • Update docs/api/react.md (already correct)
  • Update docs/api/components.md (already correct)
  • Update docs/api/designer.md with actual implemented features

Package Documentation

  • Update packages/designer/README.md with correct package names
  • Create packages/core/README.md with comprehensive usage guide
  • Create packages/react/README.md with React-specific documentation
  • Create packages/components/README.md with component library guide

Project Files

  • Update CONTRIBUTING.md with correct package references
  • Update CHANGELOG.md with current package names

Package Structure

The documentation now correctly reflects the actual package structure:

  • @object-ui/core - Core logic, types, validation (Zero React)
  • @object-ui/react - React bindings and SchemaRenderer
  • @object-ui/components - UI components (Shadcn + Tailwind)
  • @object-ui/designer - Visual schema editor

All outdated references to old packages (@object-ui/protocol, @object-ui/engine, @object-ui/renderer, @object-ui/ui) have been replaced with current package names.

Original prompt

更新文档


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 4 commits January 13, 2026 18:35
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
@huangyiirene huangyiirene marked this pull request as ready for review January 13, 2026 18:40
@huangyiirene huangyiirene merged commit d00d85f into main Jan 13, 2026
Copilot AI requested a review from huangyiirene January 13, 2026 18:40
Copilot stopped work on behalf of huangyiirene due to an error January 13, 2026 18:40
Copilot AI added a commit that referenced this pull request Jan 24, 2026
- Fix handleExportCSV to guard on gridRef.current?.api (issue #1)
- Add dedicated onContextMenuAction callback instead of overloading onCellClicked (issue #2)
- Remove icon property from customItems to prevent HTML injection (issue #3)
- Remove validation claim from README - only basic AG Grid editing (issue #4)
- Add test assertions for all new inputs (editable, exportConfig, etc.) (issue #5)
- Fix onExport type to only support 'csv' format (issue #6)
- Remove unused ColumnConfig properties (autoSize, groupable) (issue #9)
- Type schema props with proper interfaces instead of 'any' (issue #10)
- Update export description to only mention CSV (issue #11)
- Add AG Grid Community vs Enterprise section to docs (issue #8)
- Update README and docs with new callback and clarifications

All tests pass (8/8), lint clean (0 errors)

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot AI added a commit that referenced this pull request Feb 16, 2026
…nce evaluation

- Evaluate all 7 list view types (grid, kanban, calendar, gantt, timeline, map, gallery) against @objectstack/spec
- Add navigation property support matrix (width/view gaps across all plugins)
- Document TimelineConfig type alignment gap (dateField vs startDateField)
- Document GalleryConfig type export gap
- Document 10+ missing ListViewSchema spec properties
- Add new critical gaps #11-#15 to section 6.4
- Add new improvement tasks #64-#76 across P1/P2/P3
- Update section 6.1 with detailed per-view-type compliance tables
- Update section 6.3 View Enhancements with TimelineConfigSchema gap

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot AI added a commit that referenced this pull request Feb 24, 2026
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants