Skip to content

Rewrite README and restructure documentation#47

Merged
JanJakes merged 2 commits into
trunkfrom
docs-improvements
May 15, 2026
Merged

Rewrite README and restructure documentation#47
JanJakes merged 2 commits into
trunkfrom
docs-improvements

Conversation

@JanJakes
Copy link
Copy Markdown
Contributor

Summary

  • Rewrite the README to present ForkPress as a ready product with concise install, quick start, branching, merging, Git, agents, storage, logs, commands, and development sections.
  • Reorganize the documentation site sidebar around core workflows, storage, reference, project internals, and a final experiments chapter.
  • Move useful implementation details from the old README and storage notes into focused docs pages for branching, merging, Git behavior, agents, storage by platform/engine, commands, logs, architecture, development, and experiments.
  • Remove old mixed research-note docs from the main navigation and stop loading experiment README files as standalone docs pages.

Validation

  • npm run validate
  • git diff --check HEAD~1..HEAD

JanJakes added 2 commits May 15, 2026 14:04
Present ForkPress as a ready product with concise install, branch, merge, Git, agent, storage, log, command, and build guidance. Remove outdated implementation-heavy sections and document the COW storage cascade including the Linux XFS loop fallback from PR #41.
Organize the docs site around product workflows, storage behavior, reference material, and project internals. Move useful details from the old README and storage notes into focused pages, and keep non-production experiments isolated to a single final docs chapter.
@JanJakes JanJakes force-pushed the docs-improvements branch from bbbb5f4 to 94c93e1 Compare May 15, 2026 12:39
@JanJakes JanJakes marked this pull request as ready for review May 15, 2026 12:40
@JanJakes JanJakes merged commit aeffbdc into trunk May 15, 2026
10 of 11 checks passed
@JanJakes JanJakes deleted the docs-improvements branch May 15, 2026 12:41
This was referenced May 15, 2026
JanJakes added a commit that referenced this pull request May 15, 2026
## Release `v0.1.14`

Version bump and release metadata update for `v0.1.14`.

**Changelog draft:**
* Add remote-site cache branching
([#40](#40))
* Bootstrap Starlight documentation site
([#42](#42))
* Add COW mergeback and audit model
* Polish branch merge UI and harden audit follow-ups
* Guard COW row merges against target trigger rewrites
* Rewrite README and restructure documentation
([#47](#47))
* Add Linux XFS loop storage fallback
([#41](#41))
* Harden merge reliability gates and semantic coverage
([#46](#46))
* Automate release preparation and publishing
([#50](#50))
* Harden release prepare authentication
([#53](#53))
* Fix release prepare status parsing
([#54](#54))
* Polish release pull request handling
([#56](#56))
* Clarify release workflow stages

**Full changelog:**
v0.1.13-windows-cow.3...release/v0.1.14

## Next steps

1. **Review** the changes in this pull request.
2. **Push** any additional edits to this branch (`release/v0.1.14`).
3. **Merge** this pull request to publish `v0.1.14`.

Merging will automatically build ForkPress binaries, create a GitHub
release, and update the Homebrew formula.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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