docs: mkdocs index and nav redesign #5207
Conversation
github-actions
bot
added
Python
| @@ -26,6 +26,8 @@ theme: | |||
| - search.suggest | |||
| - search.highlight | |||
| - content.code.copy | |||
| - content.tabs.link | |||
There was a problem hiding this comment.
Can you please separate the tabs into a new PR to get it merged quickly, including the linked tabs option here? I was able to enable the tabs (locally), but the doc (mis)lead me to include some custom JS to keep the tabs in sync and that was not working for me.
There was a problem hiding this comment.
Yes. Sorry it took me a minute to get back to this.
There was a problem hiding this comment.
Here is the PR: #5277
man/mkdocs/index.md
Outdated
|
|
||
| Starting GRASS GIS... | ||
|
|
||
| __________ ___ __________ _______________ | ||
| / ____/ __ \/ | / ___/ ___/ / ____/ _/ ___/ | ||
| / / __/ /_/ / /| | \__ \\_ \ / / __ / / \__ \ | ||
| / /_/ / _, _/ ___ |___/ /__/ / / /_/ // / ___/ / | ||
| \____/_/ |_/_/ |_/____/____/ \____/___//____/ | ||
|
|
||
| Welcome to GRASS GIS 8.5.0dev (5ffc9ea669) | ||
| GRASS GIS homepage: https://grass.osgeo.org | ||
| This version running through: Bash Shell (/bin/bash) | ||
| Help is available with the command: g.manual -i | ||
| See the licence terms with: g.version -c | ||
| See citation options with: g.version -x | ||
| If required, restart the GUI with: g.gui wxpython | ||
| When ready to quit enter: exit |
There was a problem hiding this comment.
Maybe little too many lines? (That output should be shorter, but even a shorter one would still be little too long for here.)
There was a problem hiding this comment.
I've change the section.
man/mkdocs/index.md
Outdated
|
|
||
| ```bash | ||
|
|
||
| grass -c EPSG:3385 {project directory} --gtext |
There was a problem hiding this comment.
| grass -c EPSG:3385 {project directory} --gtext | |
| grass -c EPSG:3385 {project directory} --text |
For true no-GUI experience.
| ### Python Scripts | ||
|
|
||
| The `grass.script` module provides a Python interface to GRASS. This allows | ||
| users to write Python scripts to interact with GRASS. The `grass.script` module |
There was a problem hiding this comment.
We need to start describing the in-session version grass.script.setup.init.
man/mkdocs/index.md
Outdated
| Now you can run GRASS commands in the terminal. | ||
|
|
||
| ```sh | ||
| g.region raster=elevation | ||
| r.slope.aspect elevation=elevation slope=slope aspect=aspect | ||
| ``` |
There was a problem hiding this comment.
There is an alternative to this and that's --exec which I would say is popular for certain use cases.
man/mkdocs/index.md
Outdated
| ## Processing Tools | ||
|
|
||
| ### GRASS Tool Prefixes | ||
|
|
||
| | Prefix | Category | Description | Link | | ||
| |--------|----------------------------------|------------------------------------|-------------------------------------------| | ||
| | `g.` | General | General GIS management tools | [General Tools](general.md) | |
There was a problem hiding this comment.
Just make this presentation of tool, rather than prefixes.
| r.slope.aspect elevation=elevation slope=slope aspect=aspect | ||
| ``` | ||
|
|
||
| ### Python Scripts |
There was a problem hiding this comment.
C doc and possibly general tool writing stuff (standard parser options): I wonder if to put it here as sort of next steps ("is this not enough?") or at the end to a separate section. This would be the usage as a modeling platform.
… the mkdocs documentation
… the mkdocs documentation
[WIP] Redesign of docs index page and nav to improve overall site UX.
Related to Issue #5162