How to Contribute with the Assistant

contribute.handbook.ebrains.eu turns material you already have into a handbook page, or changes pages that already exist, and opens the merge request for you. You do not need Git, Markdown or the handbook’s folder structure. The handbook owners review every merge request before anything is published.

Sign in with your EBRAINS account.

Add a new page

  1. On Contribute, keep New page selected.
  2. Under Your material, paste what you have: notes, an email, a README, an answer you keep repeating. It does not have to be tidy, but it needs at least 120 characters. You can also drop files under Or drop files: one .md, .txt, .docx or .pdf document (up to 8 MB) and screenshots.
  3. Optionally, under A note for the assistant, say what the material is about and who it is for: “this is about the Data Proxy bucket API, for people who already use the Collab”.
  4. Select Draft the page. Drafting takes about a minute.

The assistant reads your material and the handbook’s structure, then proposes where the page goes, what kind of page it is (tutorial, how-to, reference or explanation) and the page itself. It does not invent facts: what is missing, it asks you about.

Change existing pages

  1. On Contribute, switch to Edit existing pages.
  2. Search the handbook by title or path and tick up to five pages. Preview shows a page as it is now.
  3. Under What should change?, write the change: “update the upload limit to 2 GB”, “rewrite this as a step-by-step tutorial for first-time users”, “show the request forms as cards”.
  4. Select Draft the edit.

The assistant first judges whether the change belongs in those pages. If only part of it does, or none of it, it says so and suggests where it belongs instead. Lists stay lists unless you ask for cards.

Review and refine

The draft opens for review:

  • Changes shows what changed, line by line (for edits); Preview shows the page as it will look; Edit markdown lets you change any word yourself. Select Save changes when you edit.
  • If the assistant has questions, answer them and select Redraft with these answers.
  • To try a different direction, select Ask for a different take and say what to change.
  • For a new page you can also change its title, kind, folder and position.

Nothing leaves the app until you submit. Your drafts are visible only to you.

Submit

Select Submit as merge request, read what will become part of the handbook repository, and select I understand, submit. Submitting publishes, for the reviewers:

  • the pages as they are now;
  • your original material and your note for the assistant;
  • your name and email, as the author.

Check that your material contains nothing private or confidential before you submit.

Follow up

My contributions lists everything you have drafted and where it stands:

StatusMeaning
DraftNot submitted yet. Open it to continue, or delete it with the bin icon.
Merge request openWaiting for the handbook owners. Merge request opens it in GitLab.
MergedPublished. In the handbook opens the page.
ClosedThe merge request was closed without merging. The draft is kept for reference.

Limits

Drafting uses an AI model, so there is a daily allowance of new drafts and redrafts, and a monthly budget. Your drafts always stay: you can open, edit and submit them at any time. Select How AI usage works in the app to see what you have left and when it resets.

To contribute with Git instead, see How to Contribute Online and How to Contribute Locally.

Edit this page on GitLab ↗