Skip to content

Conversation

@jackspirou
Copy link
Member

Summary

This PR reorganizes the documentation structure to create a cleaner, more intuitive layout that better reflects the Pocket architecture.

Changes

1. Removed Migration/Backwards Compatibility Documentation

  • Removed all migration guides and backwards compatibility references since Pocket hasn't launched v1.0 yet
  • Deleted: CLI_MIGRATION.md, PLUGIN_MIGRATION.md, migration sections from various docs

2. Archived Historical Planning Documents

  • Moved CLI_SPEC.md/docs/archive/
  • Moved CLI_TEST_PLAN.md/docs/archive/
  • These were planning documents for the CLI unification that has already been completed

3. Reorganized Node Documentation

  • Moved /docs/plugins/BUILT_IN.md/docs/NODE_TYPES.md
  • This clarifies that built-in nodes are NOT plugins - they're native to the framework
  • Updated all references throughout the documentation
  • Added clear notes distinguishing built-in nodes from plugins

4. Updated Documentation Structure

The /docs/README.md now shows:

  • Built-in Node Types section (for the 14 native nodes)
  • Plugin System section (for Lua and WASM extensions)

This makes the distinction clear between:

  • Built-in nodes: Native framework functionality
  • Plugins: Extensions via Lua scripting or WebAssembly

Test Plan

Documentation-only changes. Verified all internal links still work correctly.

🤖 Generated with Claude Code

- Remove migration and backwards compatibility documentation (pre-v1.0)
- Move CLI spec files to archive (CLI_SPEC.md, CLI_TEST_PLAN.md)
- Rename and relocate BUILT_IN.md to NODE_TYPES.md at docs root
- Update all references to reflect new documentation structure
- Clarify distinction between built-in nodes (native) and plugins (extensions)

This creates a cleaner documentation structure that better reflects the
architecture where built-in nodes are part of the framework, not plugins.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

❌ Your project status has failed because the head coverage (40.86%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #12      +/-   ##
==========================================
- Coverage   40.94%   40.86%   -0.09%     
==========================================
  Files          39       39              
  Lines        7393     7393              
==========================================
- Hits         3027     3021       -6     
- Misses       4215     4221       +6     
  Partials      151      151              
Flag Coverage Δ
unittests 40.86% <ø> (-0.09%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 99078aa...9efcdc1. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jackspirou jackspirou merged commit 15b1b75 into master Jul 22, 2025
7 checks passed
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.

3 participants