[Feat/graphified-feature-folder-structure] Add Graphify outputs and Add CONTRIBUTING and RUNBOOK docs, update README. - #12
Open
WUIX69 wants to merge 19 commits into
Conversation
Add generated Graphify knowledge-graph artifacts and agent guidance. This commit introduces graphify-out (graph.json, graph.html, GRAPH_REPORT.md, semantic metadata, labels, manifest, uncached list, helper scripts) plus graphify markers for python/root and a label_communities script. It also adds AGENTS.md describing how to invoke the graphify skill (including graphify query/path/explain/update rules) and adds pnpm-lock.yaml and pnpm-workspace.yaml. Update .gitignore to exclude graphify-out transient files and local agent files (.agent, .agents, .claude, .opencode) so generated and environment-specific files are not committed.
Introduce developer documentation: add docs/CONTRIBUTING.md (local setup, prerequisites, pnpm commands, environment variables, migration and seeding steps, lint/build checklist and import rules) and docs/RUNBOOK.md (deployment procedures, migration post-deploy steps, webhook endpoints/troubleshooting, health checks, and rollback guidance). Update README.md to reference the new Contributing Guide and Runbook for setup, operations, and development guidance.
Add .graphifyignore to exclude build artifacts and global UI utility (src/lib/utils.ts) to reduce noise. Regenerate Graphify outputs under graphify-out (.graphify_cached.json, .graphify_labels.json, .graphify_semantic_new.json, .graphify_uncached.txt, GRAPH_REPORT.md, graph.html, etc.), incorporating README.md and docs/CONTRIBUTING.md and docs/RUNBOOK.md into the graph. Resulting graph shows updated node/edge counts (104 nodes · 31 edges), adjusted communities and hyperedges, and improved semantic groupings.
Delete generated graphify metadata and cache files and strip hyperedge data from exported graph outputs. Removed .graphify_* files and label_communities.py, cleared inferred/extracted hyperedges from graph.json and graph.html, and updated GRAPH_REPORT.md to reflect the change (added corpus verdict and removed hyperedges section). Also includes minor reformatting/reordering of node fields in graph.json for consistency.
… structure documentation
…ign architecture with graph analysis reports
Add guidance to FEATURE-SLICED-DESIGN.md: require keeping ESLint and independentModules configs in sync for import-boundary exceptions; provide a build-time env validation bypass example (src/data/env/server.ts) using SKIP_ENV_VALIDATION; document React Server Action form type-safety (return void) and recommend useActionState for returning action state; and add guidance on exposing controlled feature public APIs via feature root index.ts. Regenerate graph outputs to reflect the documentation changes (graphify-out/*: graph.json, GRAPH_REPORT.md, .graphify_labels.json, graph.html, manifest.json).
Rewrite and reorganize docs/FEATURE-SLICED-DESIGN.md: streamline directory overview, introduce "Feature-First Mini-Applications" and the "Rule of Promotion", clarify import boundary rules and controlled feature communication (public index APIs), and add concrete guidance/examples for Next.js Server Actions type-safety and useActionState. Remove duplicated sections and tidy layout/layout comments. Regenerate graphify outputs (graph.json, GRAPH_REPORT.md, manifest.json, graph.html) to reflect documentation changes and updated analysis metadata.
Revise docs/FEATURE-SLICED-DESIGN.md: restructure and expand the project layout (add contexts, layout/components breakdown, types/utils), clarify FSD rules, update examples for Next.js Server Actions and dbCache (formatting, semicolons, trailing commas), and remove the explicit “Controlled Feature Communication” snippet. Refresh graphify outputs (graph.json, graph.html, GRAPH_REPORT.md, .graphify_labels.json, manifest.json) and add .graphify_incremental.json to reflect the latest codebase scan (includes deletion of src/lib/utils.ts). These changes improve clarity, consistency, and keep the documentation and generated graph metadata in sync with the repository.
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
1 participant
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.
Add generated Graphify knowledge-graph artifacts and agent guidance. This commit introduces graphify-out (graph.json, graph.html, GRAPH_REPORT.md, semantic metadata, labels, manifest, uncached list, helper scripts) plus graphify markers for python/root and a label_communities script. It also adds AGENTS.md describing how to invoke the graphify skill (including graphify query/path/explain/update rules) and adds pnpm-lock.yaml and pnpm-workspace.yaml. Update .gitignore to exclude graphify-out transient files and local agent files (.agent, .agents, .claude, .opencode) so generated and environment-specific files are not committed.
Introduce developer documentation: add docs/CONTRIBUTING.md (local setup, prerequisites, pnpm commands, environment variables, migration and seeding steps, lint/build checklist and import rules) and docs/RUNBOOK.md (deployment procedures, migration post-deploy steps, webhook endpoints/troubleshooting, health checks, and rollback guidance). Update README.md to reference the new Contributing Guide and Runbook for setup, operations, and development guidance.