doc: Publish the doc as a single text file
What
Publish the doc as a single file octezdoc.txt.
Why
This file can be used to train various AI bots.
How
Curate the produced text file by:
- ordering the pages as on the website
- excluding some files that can confuse the bot, typically large generated files such as the CLI manuals
Manually testing the MR
- Build the text file in the MR branch locally by
make -C docs _build/octezdoc.txt - Inspect that file to see that it contains the pages in the same order as on the website
- Check that the
Admin-client manualhas been omitted, by searching this string
But ultimately, I'm afraid we can only test the published file after the MR is merged, by checking if the text file is produced at https://tezos.gitlab.io/octezdoc.txt and https://octez.tezos.com/docs/octezdoc.txt
Checklist
-
Select suitable reviewers using the Reviewersfield below. -
Select as Assigneethe next person who should take action on that MR