knuckleswtf / knuckleswtf/scribe

Split documentation into multiple files

Open
#1,077 4 comments 0 reactions 0 assignees View on GitHub
bug triage
Dominant language
PHP
Stars
2.3k
Forks
357
PR merge metrics
No merged PRs in 30d

Description

### Scribe version

5.6.0

### PHP version

8.3

### Laravel version

12

### Scribe config

```ruby
base_url => "https://dev-api.example.com"
type => "static"
theme => "elements"
auth.enabled => true
auth.default => true
examples.faker_seed => null
strategies.headers => added [
'Knuckles\\Scribe\\Extracting\\Strategies\\StaticData',
[
'data' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
],
]: removed [
'Knuckles\\Scribe\\Extracting\\Strategies\\StaticData',
[
'only' => [],
'except' => [],
'data' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
],
]
strategies.responses => added [
'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
[
'only' => [
'GET *',
],
'config' => [
'app.debug' => false,
],
],
]: removed [
'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
[
'only' => [
'GET *',
],
'except' => [],
'config' => [
'app.debug' => false,
],
'queryParams' => [],
'bodyParams' => [],
'fileParams' => [],
'cookies' => [],
],
]
routeMatcher => "Knuckles\\Scribe\\Matching\\RouteMatcher"
```

### What happened?

I have quite a number of endpoints, which makes the documentation's index.html file quite large and causes it to hang in the browser. Is there an option to split the documentation into multiple pages rather than have one big index.html?

### Docs

- [x] I've checked [the docs](https://scribe.knuckles.wtf/laravel), the [troubleshooting guide](https://scribe.knuckles.wtf/laravel/troubleshooting), and [existing issues](https://github.com/knuckleswtf/scribe/issues?q=is%3Aissue+), but I didn't find a solution

Contributor guide

Open the contributing guide

Research direction

Start by examining the static documentation output, especially the generated index.html, and trace how its endpoint content is assembled. Determine whether multiple pages can be generated without breaking navigation, then verify that large API documentation loads without the browser hanging.

Written by the indexing model from the issue text.

Assessment

Tech stack
laravel, php
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.