Provide complete docs as single-file download to put into LLM context windows
- Dominant language
- C++
- Stars
- 123k
- Forks
- 17.5k
- Avg merge
- 14h 22m
- Merged PRs (30d)
- 873
Description
### Preflight Checklist
- [x] I have read the [Contributing Guidelines](https://github.com/electron/electron/blob/main/CONTRIBUTING.md) for this project.
- [x] I agree to follow the [Code of Conduct](https://github.com/electron/electron/blob/main/CODE_OF_CONDUCT.md) that this project adheres to.
- [x] I have searched the [issue tracker](https://www.github.com/electron/electron/issues) for a feature request that matches the one I want to file, without success.
### Problem Description
It would be nice to have a single file that includes all of our docs so that we can throw it into LLM context windows.
Inspired by:

### Proposed Solution
Create a single huge markdown file that is all of the other markdown files from our project concatenated.
Publish it as an additional file for each GitHub release. (Thanks to @erickzhao for the idea of attaching it to releases!)
Follow-up task: Link to it from `electron/website`.
### Alternatives Considered
Have LLMs search the Electron website instead. Not efficient. Doesn't work super well as of now.
### Additional Information
Working prototype (script created entirely by ChatGPT): [generateDocs.ts.txt](https://github.com/user-attachments/files/20717859/generateDocs.ts.txt)
This generates this 1.6MB markdown file.
#### How well does it work?
I put the output into ChatGPT and asked about a new feature that isn’t in the training data of the model yet. I picked macOS writing tools.
- GPT-4o couldn’t tell me how to add writing tool support.
- o4-mini, however, did find the right answer in the docs.
Contributor guide
Assessment
This issue has not been assessed yet.