Skip to content

Polish object_store.md and regroup walkthrough nav - #108

Closed
susan-pgedge wants to merge 2 commits into
docs/light-editsfrom
docs/usage-nav-cleanup
Closed

susan-pgedge wants to merge 2 commits into
docs/light-editsfrom
docs/usage-nav-cleanup

Conversation

@susan-pgedge

Copy link
Copy Markdown
Member

Summary

  • Rewrote docs/object_store.md: removed step numbers from headings
    (per the updated pgedge-docs skill guidance against step numbers in
    headings), moved the "targets real cloud S3" / "no prior knowledge"
    paragraphs into Prerequisites, tightened the intro prose, clarified
    what docker compose up starts, and folded the three Lakekeeper
    setup steps (bootstrap, create warehouse, pre-create namespace) into
    flowing prose with First/Next/Then transitions instead of
    subheadings, for consistency with how the rest of the page handles
    sequential steps. Fixed two cross-references and the setup script's
    own stale step reference to match.
  • docs/usage.md: fixed an ambiguous "Operating It" heading to
    "Operating the Partitioner", renamed "Prerequisites (Both Modes)"
    to "Configuring the Prerequisite Services", and updated a
    cross-reference anchor to match object_store.md's restructuring.
  • mkdocs.yml: grouped the four walkthrough demo pages under a new
    "ColdFront Walkthroughs" nav subsection.

Test plan

  • mkdocs build --strict passes locally
  • Spot-check the rendered object_store.md and nav

@susan-pgedge
susan-pgedge requested a review from vyruss as a code owner October 7, 2026 13:49
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: pgEdge/coldfront/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 0d6be79c-880f-4376-8f80-6c6ba9067f13

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@susan-pgedge

Copy link
Copy Markdown
Member Author

Closing without merging - pulled these changes into docs/standard-toc-experiment instead, as part of a broader nav restructuring. The object_store.md title conflict with the already-shipped PR #106 fix was resolved in favor of the shipped wording ("Configuring your Object Store").

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