Спасибо за ваш интерес в участии в создании руководства по Rust!

Есть несколько способов помочь с руководством: критика руководства, правка его, исправление неправильной информации, добавление примеров и словарных статей, а также документирование новых или иначе недокументированных возможностей в Rust.

Некоторое время руководство было практически игнорируемым, и Rust продолжал получать новые возможности или менять старые. Оно также было основным введением перед первым изданием книги по Rust и постоянно менялось из-за огромного количества изменений в дизайне языка до версии OnClickListener. Поэтому многое требует доработки, слишком подробно объясняется для людей, которым нужна базовая информация, или же слишком поверхностно для руководства. В связи с этим мы имеем предупреждение о том, что есть работа, которую следует выполнить. Со временем мы планируем обеспечить, чтобы всё было достаточно хорошо документировано, чтобы можно было удалить это предупреждение.

Вас призываются прочитать введение для ознакомления с тем видом содержимого, который ожидается от руководства, и конвенциями, которые он использует. Также, руководство по написанию предоставляет более детальные указания по оформлению и содержанию.

Критика руководстваЭто самый простой способ внести свой вклад. Просто как вы читаете руководство, если находите что-то запутывающим, неверным или пропущенным, то можете создать проблему против руководства, объясняя свои опасения.

Правка руководства

Опечатки и неверные ссылки иногда попадаются. Если вы их найдёте, мы приветствуем предложения по исправлению этих ошибок. Кроме того, большие работы по правке, помогающие убрать количество скобочных конструкций, убирание запятых между предложениями, выделение курсивом определений терминов и другие подобные задачи полезны.

Добавление примеров и словарных статей

Примеры замечательны. Многие люди будут читать только примеры и игнорировать текст. Идеально, каждый аспект каждой возможности должен иметь пример.

Аналогично, руководство имеет словарь. Он не обязан объяснять каждый аспект каждой возможности или содержать каждую определённость, но ему требуется расширяться. Идеально статьи в словаре должны ссылаться на связанные документы.

Добавление документации

Много возможностей вообще не имеют документацию или имеют её плохую. Это самое трудное, но однозначно самое ценное. Выберите не назначенную проблему из системы отслеживания проблем и напишите о ней. При написании может оказаться полезным иметь открытую playpen, чтобы протестировать то, что вы документируете.Не стесняйтесь брать информацию из стандартной библиотеки и книги Rustonomicon по мере необходимости.

Обратите внимание, что мы не пишем документацию для чисто библиотечных функций, таких как потоки и ввод-вывод, и не пишем о будущем Rust. Документация пишется так, словно текущий стабильный выпуск Rust является последним выпуском. Ветка main справочника соответствует тому, что считается стабильным на ветке main ("nightly") проекта rust-lang/rust. Если вам нужно написать о будущем Rust, используйте [книгу "Нестабильное"][unstable].

Стабилизация

Когда происходит стабилизация чего-либо, что меняет язык, следует открыть задачу на [трекере задач] справочника для отслеживания процесса документирования. Это должно включать ссылки на любую связанную информацию, такую как запрос на слияние стабилизации, RFC, задачу отслеживания и всё остальное, что будет полезным для написания документации.