Развить структуру документации и проработать заглавную страницу #36

New issue

Closed

opened 2025-11-18 18:42:35 +03:00 by mxustin · 1 comment

mxustin commented

2025-11-18 18:42:35 +03:00

Member

Как сам подход к ведению документации docs-as-code, так и конкретный результат, который мы получаем, — очень радует.

В то же время, документация по ₽убасу —
• во-первых, занимает отдельный сервер;
• во-вторых, выглядит совсем не так красиво.

Родилась идея: объединить документацию по всем проектам (единый подход, единый сайт документации).

Для этого:

проработать структуру, которая бы включала:
- проекты
- разные типы документации (пользовательская, инженерная)
проработать заглавную страницу (хорошо бы, чтоб она были не «заглушкой»)
перенести документацию из wiki ₽убас (и освободить ресурс)

Как сам подход к ведению документации docs-as-code, так и конкретный [результат](https://docs.viewergy.online/concept.html), который мы получаем, — очень радует. В то же время, [документация по ₽убасу](https://myrubas.ru/) — • во-первых, занимает отдельный сервер; • во-вторых, выглядит совсем не так красиво. Родилась идея: объединить документацию по всем проектам (единый подход, единый сайт документации). Для этого: - [x] проработать структуру, которая бы включала: - [x] проекты - [x] разные типы документации (пользовательская, инженерная) - [x] проработать заглавную страницу (хорошо бы, чтоб она были не «заглушкой») - [ ] перенести документацию из [wiki ₽убас](https://myrubas.ru/) (и освободить ресурс)