Skip to content

README: add a Frequently asked questions section - #188

Draft
taz-mon wants to merge 2 commits into
mainfrom
taz/readme-faq
Draft

taz-mon wants to merge 2 commits into
mainfrom
taz/readme-faq

Conversation

@taz-mon

@taz-mon taz-mon commented Oct 29, 2026

Copy link
Copy Markdown
Collaborator

What this changes

Adds a Frequently asked questions section to the README, placed after "Uninstall GemDB Code" and before "Privacy", so Privacy, License and the tracking pixel stay at the end. The questions come from first-time readers who are evaluating GemDB:

  • What kind of database is GemDB?
  • How do you find data by something other than its key?
  • What happens when two sessions change the same data?
  • Are there performance numbers?
  • How do I work with my data outside my application code?
  • How large can a database get?

Answers are short. Where the real answer is a conversation, they end with a Contact Sales link instead of adding detail the product does not support yet.

Two sections move into the FAQ as entries, with their text unchanged apart from the headings:

  • Commands is now "What commands does GemDB Code add?"
  • Using GemDB Code vs. GemStone/S is now "How is GemDB Code different from GemStone/S and Jasper?"

Readers find the FAQ from a sentence near the top of the README and from the Reference contents list. The two moved entries are removed from that list.

Also in this PR

  • Commands table: adds GemDB: Show Database Sessions (in the ⋯ menu while the database is running, or click the Sessions row) and GemDB: Open in GemDB Stats (not in the Command Palette; right-click an .out or .out.gz file in the Explorer). Both are checked against package.json, src/statusView.ts and the 1.9.0 changelog.
  • Sessions section: a paragraph on the Show Database Sessions tab, what it lists, and that it reads only when it opens or you press Refresh.
  • Small wording fixes in the Commands section: "GemDB Notebook's toolbar", the Stop GemDB row, and the table introduction.

Checks

  • In-page links resolve, including the new #persisted-objects, #inspect-an-object, #connect-an-ai-agent and #modules-and-namespaces links.
  • prettier@3.9.10 --check passes.
  • Spelling check completed.

🤖 Generated with Claude Code

taz-mon and others added 2 commits October 29, 2026 10:12
Six questions from first-time readers: what kind of database GemDB is, how to
find data other than by key, what happens when two sessions change the same
data, performance, working with data outside application code, and size
limits. Each short answer ends with a Contact Sales link where the detail
belongs in a conversation.

Move the Commands table and the GemStone/S comparison into the section as
entries, and add a link from the intro and the Reference contents list.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Add a short introduction to the FAQ, a Sessions paragraph for the new Show
Database Sessions tab, and Commands table rows for Show Database Sessions and
Open in GemDB Stats. Reword a few FAQ sentences in plainer terms and link MCP
server and namespace to the sections that explain them. Fix "GemDB Notebook"
capitalisation and two awkward sentences in the Commands section.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@taz-mon
taz-mon requested review from crcsmnky and jgfoster October 29, 2026 15:51

This branch has not been deployed

No deployments
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.

1 participant