docs: add describe_database verification step to getting-started guide#514
Merged
Conversation
…uide After running `harper dev .`, new users had no way to confirm their schema.graphql was processed and the Dog table was created before moving on to enabling the REST API. Adds a "Verifying the Table Was Created" section that shows `harper describe_data` and its expected output. Paired with HarperFast/harper#1110 which adds the command. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-514 This preview will update automatically when you push new commits. |
Switch from the (now-closed) describe_data proposal to the existing harper describe_database database=data operation, which already works via the CLI passthrough. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
kriszyp
changed the title
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-514 This preview will update automatically when you push new commits. |
cb1kenobi
approved these changes
Jun 3, 2026
Ethan-Arrowood
approved these changes
Jun 3, 2026
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
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
3 participants
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.
Summary
Adds a "Verifying the Table Was Created" section between "Running the Application" and "Enabling the REST API" in the getting-started guide.
The gap it fills: after running
harper dev ., new users have no indication that their schema was processed and theDogtable was created. Without a verification step they jump straight to enabling the REST API with no confidence the table actually exists.The new section uses the existing
harper describe_database database=dataCLI passthrough (no new command needed) and shows the expected YAML output so users know what success looks like.Test plan
harper describe_database database=data, confirm output matches the docs example🤖 Generated with Claude Code