Skip to content

docs: add Project-Structure.md — repository-wide architecture reference#1

Open
Copilot wants to merge 2 commits into
masterfrom
copilot/analyze-overall-structure
Open

docs: add Project-Structure.md — repository-wide architecture reference#1
Copilot wants to merge 2 commits into
masterfrom
copilot/analyze-overall-structure

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 20, 2026

No single document described the overall layout of the IoT.js codebase, making onboarding and navigation unnecessarily hard.

Changes

  • docs/devs/Project-Structure.md — new reference document covering:

    • Top-level directory/file inventory with purpose annotations
    • src/ sub-tree breakdown: core C files, src/js/ JS modules (per-module tables), src/modules/ native C impls, src/napi/ N-API layer, src/platform/ OS abstraction
    • deps/, cmake/, config/, profiles/, tools/, test/, docs/ sections
    • End-to-end build pipeline diagram and representative tools/build.py invocations
    • Runtime dependency graph across all supported platforms (Linux, NuttX, Tizen, TizenRT)
  • docs/README.md — adds Project Structure as the first link under the Developer Guide section in the documentation index


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: haesik <18200777+haesik@users.noreply.github.com>
Copilot AI changed the title [WIP] Analyze overall structure of the project docs: add Project-Structure.md — repository-wide architecture reference Feb 20, 2026
Copilot AI requested a review from haesik February 20, 2026 05:49
Copy link
Copy Markdown
Owner

@haesik haesik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@haesik haesik marked this pull request as ready for review February 20, 2026 09:33
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