GitbookIO / GitbookIO/integrations

The "document" format for page content isn't documented

Open
#528 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improvement
Dominant language
TypeScript
Stars
131
Forks
96
Avg merge
7h 8m
Merged PRs (30d)
31

Description

Endpoints that return page content generally allow you to select either markdown or document formats. From what I can tell, the document format isn't actually documented anywhere, which limits its utility.

This is problematic in my case because the AI search sources refer to page sections by their keys. I can't get the key for a particular page section unless I get the doc back in document format. I want to be able to pull out the relevant sections from an AI search response and feed them back into an LLM, formatted as markdown for additional context. However in order to do that I'd need to reverse engineer your document format, or go find the code that defines it in the main gitbook repo.

If I'm wrong about this, and the document format is documented somewhere, please make it more discoverable from the docs pages, as I've searched around and come up empty-handed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation pages for endpoints that return page content and the document format mentioned in the issue. Trace how AI search source section keys relate to that response, then document the format and link it from the relevant docs so users can find it and use it to retrieve sections as markdown.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.