How does a teammate review a help-page correction?
Edit in the browser and put the update in a change request. It gives the team a draft to inspect before it is merged. Git Sync also lets a connected GitHub or GitLab repository hold and review changes. Free lists one user. Check the paid comparison for collaborators and review controls.
Who can open the published guide?
A GitBook site publishes selected documentation spaces. Check its audience setting separately from the people who edit the workspace. GitBook documents public access, revocable share links and authenticated access, with eligibility varying by plan. You can unpublish the site from its settings.
If you need readers to sign in individually, check the authenticated-access plan before choosing how to share the site.
When can GitBook create a developer reference?
Supply an OpenAPI description, a file that lists the actions your app makes available to other software and the inputs each action accepts. GitBook can turn it into reference pages. Keep an ordinary guide for customers who only need to follow a task.
What will move with the Markdown?
With Git Sync enabled, the connected repository can hold the Markdown source. GitBook says custom blocks, embedded media and nested structures can need manual work when migrating. Keep a copy and check how the destination displays a page with an image and a callout.
What would you check before updating a published help page?
Sketch this using fictional text and attachments. Keep the exercise on paper without connecting a workspace or publishing a page.
- Write an old and new stepFor a fictional reservation app, replace an outdated menu name.
- Mark the draft and the reader copyGive a second person the change to inspect. Mark the audience before the new copy goes live.
- Check the portable copySketch what the plain text contains and which callout or image must be checked separately.