Skip to content

docs: fix dev setup instructions for Gradata/ subfolder#123

Merged
Gradata merged 1 commit into
mainfrom
docs/post-reorg-setup
Apr 20, 2026
Merged

docs: fix dev setup instructions for Gradata/ subfolder#123
Gradata merged 1 commit into
mainfrom
docs/post-reorg-setup

Conversation

@Gradata

@Gradata Gradata commented Apr 20, 2026

Copy link
Copy Markdown
Owner

Summary

After Phase B (#121) the SDK lives under Gradata/ rather than the repo root. The documented install steps (cd gradata && pip install -e .) would fail because pyproject.toml is one level deeper. Updating CONTRIBUTING.md and docs/contributing.md to cd gradata/Gradata and noting the subfolder layout.

Test plan

After Phase B (#121) the SDK lives under `Gradata/`, not the repo
root. New contributors running the documented install steps would
land in the wrong directory and hit a "No pyproject.toml" error.

- CONTRIBUTING.md: `cd gradata/Gradata` and note the subfolder layout
- docs/contributing.md: same update, keeps the two docs in sync

Co-Authored-By: Gradata <noreply@gradata.ai>

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@Gradata Gradata merged commit b15cb0b into main Apr 20, 2026
1 check was pending
@Gradata Gradata deleted the docs/post-reorg-setup branch April 20, 2026 07:35
@coderabbitai

coderabbitai Bot commented Apr 20, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: de443822-da64-439c-a63b-a9225f69d62b

📥 Commits

Reviewing files that changed from the base of the PR and between 30238e9 and 331df4d.

📒 Files selected for processing (2)
  • Gradata/CONTRIBUTING.md
  • Gradata/docs/contributing.md

📝 Walkthrough
  • Updated development setup instructions in CONTRIBUTING.md and docs/contributing.md to reflect SDK location after Phase B reorganization
  • Changed installation directory from cd gradata to cd gradata/Gradata before running pip install -e .
  • Added clarification that the SDK resides in the Gradata/ subfolder with workspace-level scaffolding at the repo root
  • Documentation-only changes with no impact to public APIs or breaking changes
  • Modified files: Gradata/CONTRIBUTING.md (+3/-1), Gradata/docs/contributing.md (+2/-2)

Walkthrough

Updated development documentation across two contributing guide files to clarify that SDK commands and dependency installation should be executed from the gradata/Gradata subfolder, reflecting the SDK's relocation within the repository structure.

Changes

Cohort / File(s) Summary
Documentation Updates
Gradata/CONTRIBUTING.md, Gradata/docs/contributing.md
Updated working directory instructions from gradata to gradata/Gradata for SDK command execution. Added clarification that the SDK resides under the Gradata/ subfolder and all related commands should be run from that directory.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

docs

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/post-reorg-setup

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot added the docs label Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant