[GRASS-git] [OSGeo/grass] c4a1be: docs: MkDocs index and nav redesign (#5207)

[Corey White]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: c4a1beb9c65d0d90fa3de110ef5714bc83f319d4
      https://github.com/OSGeo/grass/commit/c4a1beb9c65d0d90fa3de110ef5714bc83f319d4
  Author: Corey White <smortopahri at gmail.com>
  Date:   2025-03-07 (Fri, 07 Mar 2025)

  Changed paths:
    M man/Makefile
    M man/build.py
    M man/build_index.py
    M man/build_md.py
    A man/mkdocs/docs/command_line_intro.md
    A man/mkdocs/docs/development_intro.md
    A man/mkdocs/docs/interfaces_overview.md
    A man/mkdocs/docs/jupyter_intro.md
    A man/mkdocs/docs/python_intro.md
    M man/mkdocs/grassdocs.css
    A man/mkdocs/index.md
    M man/mkdocs/mkdocs.yml

  Log Message:
  -----------
  docs: MkDocs index and nav redesign (#5207)

New concept for navigation, index, documentation structure and intro pages for the new Markdown-based MkDocs doc, specifically:

- Completely redesign index page to be Getting started page with overview and just couple links elsewhere.
- Add intro pages for interfaces (for now, getting started with interface and overview of interface are the same pages).
- Change navigation to highlight interfaces, concepts, and tools.

This is a first draft, and several issues should be addressed later. Besides the content, links to addons and libpython need a revision.

Related to issue #5162. (Originally raised as index page redesign, but index page does not have to make up for a menu anymore because we do have a menu with MkDocs.)

Selected details:

- Removed old code to build index.html in Python and replaced with a index.md file in Markdown.
- Carefully linked download and tutorials in navigation and files. Links the tutorials site from Getting started.
- Development docs is a placeholder.
- A quickstart.md file considered, but it turned out not to be different from the index itself.
- Add new intro files for interfaces.
- Add a flatten Processing Tools menu by moving intro pages to concepts leaving Processing Tools as more pure API reference, using full_index as index page for Processing Tools.
- Does not include much interfaces in the index page, instead uses a main page for Interfaces to provide an overview and counts on future Getting started guides for each interface. For now, repeats interfaces in getting started, but in the future, these would be shorter intros with more context and less examples.
- Divide command line interface into interactive shell, command exec, and scripting.
- Use command line rather than terminal and shell, and use those only when appropriate.
- As a first draft, it does not include any images.
- For links to Python doc, use absolute URLs with grass-stable.

---------

Co-authored-by: Anna Petrasova <kratochanna at gmail.com>
Co-authored-by: Vaclav Petras <wenzeslaus at gmail.com>



To unsubscribe from these emails, change your notification settings at https://github.com/OSGeo/grass/settings/notifications