Skip to content

Moving readme#388

Merged
kfirstri merged 3 commits intomainfrom
readme-fix
Mar 9, 2026
Merged

Moving readme#388
kfirstri merged 3 commits intomainfrom
readme-fix

Conversation

@artemdemo
Copy link
Contributor

@artemdemo artemdemo commented Mar 9, 2026

Note

Description

This PR moves the README.md from the repository root into packages/cli/README.md, which is the canonical location for the CLI package's documentation. The root README.md is replaced with a symlink pointing to ./packages/cli/README.md, ensuring the file content is maintained in a single place while remaining accessible from both locations.

Related Issue

None

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Other (please describe): Repository structure improvement — relocates README to the package directory and replaces root with a symlink

Changes Made

  • Moved the full README.md content from the repo root to packages/cli/README.md
  • Replaced the root README.md with a symlink (./packages/cli/README.md) to avoid duplication
  • No content changes were made to the README itself

Testing

  • I have tested these changes locally
  • I have added/updated tests as needed
  • All tests pass (npm test)

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have updated docs/ (AGENTS.md) if I made architectural changes

Additional Notes

Collocating the README with the packages/cli package makes it easier to keep documentation in sync with the package code and is the standard convention for monorepo-style projects where the package is published from a subdirectory.


🤖 Generated by Claude | 2026-03-09 00:00 UTC

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/cli@0.0.40-pr.388.14f82ff

Prefer not to change any import paths? Install using npm alias so your code still imports base44:

npm i "base44@npm:@base44-preview/cli@0.0.40-pr.388.14f82ff"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "base44": "npm:@base44-preview/cli@0.0.40-pr.388.14f82ff"
  }
}

Preview published to npm registry — try new features instantly!

@artemdemo artemdemo marked this pull request as ready for review March 9, 2026 09:08
README.md Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

whoops, maybe it's need to be relative somehow

Copy link
Contributor Author

Choose a reason for hiding this comment

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

right, fixed

@kfirstri kfirstri merged commit 09d3fb5 into main Mar 9, 2026
11 checks passed
@kfirstri kfirstri deleted the readme-fix branch March 9, 2026 09:28
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