wagtail / guide

A website to teach Wagtail CMS to content editors, moderators and administrators.
https://guide.wagtail.org
BSD 3-Clause "New" or "Revised" License
32 stars 26 forks source link

Missing Documentation for Navigation Settings in Support Guide #332

Closed nouman17610 closed 1 year ago

nouman17610 commented 1 year ago

User guide contains no content related to "how to update navigation settings. There is no information available for the navigation page. Editing-Navigation-settings-Wagtail

Why navigation page should be documented? Although it is a page for a simple 3 URLs but it is important for user to know about the purpose of this page. Without an information, user may not understand the functionality of the navigation settings page. Existing users find it easy to updates the URLS. New user find it difficult to understand the type of URLs required. Effective documentation can reduce the confusion of user while editing the URLs of social profiles. Documentating the navigation setting is important for future changes. Later on, this page may get more updates about navigation settings. Docs team would need less time to complete documentation for upcoming features in the navigation page. Furthermore, user guide must ensure consistency of documenting all the features.

How it should be documented? Documentation should follow these steps to document the navigation settings page

Scotchester commented 1 year ago

Hi @nouman17610,

Thank you for reporting this, but Navigation Settings is not a stock Wagtail feature. They are custom settings that have been added by the developer(s) of the site you are working with. Therefore, they should not be documented in the general Wagtail User Guide.