mirror of
https://github.com/webstudio-is/webstudio.git
synced 2026-10-28 07:37:36 +09:00
Oleg Isonen
99371187dc
## Summary - move the complete GitBook documentation tree and assets into Builder under `/docs` - generate the exhaustive MCP page from the local CLI source in the same change - publish GitBook from a release-gated `docs` branch containing the exact successfully released revision - run MCP documentation tests, typechecking, and stale-output checks with the existing generated-docs check - remove links to the Community Discussions repository ## Technical choices - Import the current documentation as a linear snapshot so the branch satisfies Builder's required-linear-history protection. - Keep the Markdown wrapper separate from the TypeScript generator at `scripts/docs/mcp-page.md`. - Generate through `packages/cli/local.js` so CLI guidance and its documentation are reviewed together. - Let `check:generated-docs` reject CLI changes that leave the committed MCP page stale. - After both GitHub release creation and package publication succeed, fast-forward the read-only `docs` branch to the immutable release tag commit. A divergent update fails instead of publishing a different revision. - Configure GitBook to publish `/docs` from the `docs` branch, not directly from `main`. - Exclude `/docs` from the repository-wide `oxfmt` scan so imported GitBook Markdown retains its established formatting; generator tests and stale-output checks still validate the MCP page. - Exclude `transcripts/` and GitHub Discussions from the migration. ## Todo - [x] Import documentation, navigation, includes, and assets under `/docs`. - [x] Generate the MCP page from the local CLI source. - [x] Move MCP generation and validation into Builder. - [x] Require MCP documentation updates alongside CLI changes. - [x] Publish released revisions through a read-only `docs` branch. - [x] Remove Community repository links from Builder and the migrated docs. - [x] Preserve and verify a final Community Git bundle locally. - [ ] Merge this pull request. - [ ] Let the next successful release create or advance the `docs` branch. - [ ] Repoint GitBook Git Sync to `webstudio-is/webstudio`, branch `docs`, root directory `/docs`. - [ ] Verify `docs.webstudio.is`, navigation, assets, anchors, and the MCP page in production. - [ ] Delete `webstudio-is/webstudio-community`. ## Verification - `pnpm check:generated-docs` - `pnpm lint` - `pnpm oxfmt --check` - `git diff --check origin/main...HEAD` - generator regression test demonstrated failing when the GitBook wrapper behavior was removed, then passing after restoration - no fixture inputs or outputs are affected ## Known limitation All documentation merged after the previous release waits for the next successful release before GitBook publishes it. This deliberately keeps the public MCP reference aligned with an installable CLI revision. Ref #5986
2.3 KiB
2.3 KiB
description, icon
| description | icon |
|---|---|
| How to fix overflowing content so the screen doesn't scroll horizontally. | computer-mouse-scrollwheel |
Fixing overflow issues
Sometimes, the content takes up too much space, causing unintentional horizontal scroll. This frustrates users, especially on mobile, and should be remedied.
Here's a video demonstrating how to diagnose and fix it. After the video, there are detailed instructions.
{% embed url="https://vimeo.com/1031704623" %}
Find the culprit
Toggle "Show" on each instance in the navigator until the horizontal scroll goes away.
It's best to start with the outermost wrappers, like the header, main, and footer, to see which one is causing it, then drill down to inner wrappers, like sections.
Continue going deeper into the nested instances until you find the innermost instance causing the horizontal scroll.
Fix the culprit
There is something in the culprit causing the content to extend past the viewport boundaries.
Many styles can cause overflow, but here are some common things to look for:
| Issue | Solution |
|---|---|
| Fixed widths | Remove it or set to auto |
| Flex rows without the ability to wrap | Allow wrapping |
| A single word like "responsibility/accountability" (note the "/" will prevent it from breaking). | Separate with a space |
| Wide content that can't wrap | Set overflow to auto |
Related
- Anatomy of the Webstudio builder – Learn the builder interface and how to navigate instances
- Element – The fundamental building block for creating layouts
- Layout & Flexbox – Understand how layouts work to prevent overflow
- Responsive design – Build layouts that adapt to different screen sizes