Для решения такого плана проблем использую следующую схему: затягиваю файл из кодового репозитория в репозиторий документации (прямо в репозиторий без git ignore), для этого использую какой-то подручный скрипт. Далее в момент сборки (ведь в любом случае возникает момент, когда артефакты документации и исполняемые артефакты сливаются во что-то одно) проверяю, что файл в программных исходных кодах и документации одинаковые. Если нет, сборка фейлится. Т.е. предлагается человеку, отвечающему за документацию выполнить обновление... и хотя бы посмотреть, что документация не поехала

А есть ли такая штука, которая максимально упрощает редактирование документов через git для не-программистов? Грубо говоря, по одной кнопке создает форк, issue, pr и сразу показывает WYSIWYG редактор, а после завершения правок опять по одной кнопке переводит pr из режима черновика.

форки, issues, pr не являются объектами предметной области git. это сущности в контексте какой-то надстройки над git, поэтому уточните вопрос

это прекрасная ниша для стартапа

https://hackmd.io/ ?

Ну и ещё Grav CMS, Netlify-не-помню-название, и разные другие

Допустим, пишется книга под лицензией Open Source. Есть желание использовать все преимущества GitHub/GitLab Flow - форки, пулл реквесты. Но книга не про программирование, и часть авторов не программисты. А хочется чтобы и им было удобно, и Flow сохранился.

Так ведь веб-интерфейсом гитхаба вполне можно пользоваться

И там почти что wysiwyg

да, у самих github/gitlab кажется процесс очень приближен в интерфейсе к условному «текстовому редактору»

Для совместной работы переводчиков, к примеру, уже есть онлайн инструменты. Наверняка есть и для писателей.

По одной кнопке сразу и форк, и issue, и PR?  Бывает такой желанный flow?

Коллеги, подскажите, что используете для live preview при создании rst файлов. Плагин для vscode показывает изменения только при сохранении файла.

А чем собираете доки? Sphinx, pandoc?

Да, я проверил, там при нажатии кнопки Edit file в чужих репозиториях ровно это и происходит!

Пока ни в чем) Подбираю инструменты. В данном случае рассматриваю sphinx. Плюс видимо для pdf понадобится pandoc.

Тогда вам превью в редакторе не очень-то и нужно, гораздо лучше превью готовой доки в браузере. используйте sphinx-autobuild

Кстати, проблема в VSCode ушла после переустановки плагина. Хотя баг описан.

Спасибо, попробую. Тут вопрос, насколько быстро это будет все работать. На начальном этапе изучения разметки важно, чтобы изменения сразу отображались, как мне кажется.

Пока документация маленькая, за секунды