Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues in Markdown doc files #1333

Closed
6 tasks done
wenzeslaus opened this issue Feb 20, 2025 · 5 comments
Closed
6 tasks done

Fix issues in Markdown doc files #1333

wenzeslaus opened this issue Feb 20, 2025 · 5 comments
Labels
manual Documentation related issues

Comments

@wenzeslaus
Copy link
Member

wenzeslaus commented Feb 20, 2025

Essential:

  • implement fixes to remove ignores in linting config
  • remove block quotes from r.green tools
  • inspect images (by sampling, regexp)
  • reduce cases where sh code blocks are used for things which are not sh docs: fix code blocks language #1359

Transition-related:

Optional:

Originally listed here, but later identified as out of scope:

@wenzeslaus wenzeslaus added the manual Documentation related issues label Feb 20, 2025
wenzeslaus added a commit to wenzeslaus/grass-addons that referenced this issue Mar 3, 2025
Enable commands-show-output from markdownlint globally, and disable it for the problematic code blocks in r.fuzzy.system.

See also OSGeo#1333 and OSGeo#1334.
petrasovaa pushed a commit that referenced this issue Mar 4, 2025
Enable commands-show-output from markdownlint globally, and disable it for the problematic code blocks in r.fuzzy.system.

See also #1333 and #1334.
@wenzeslaus
Copy link
Member Author

Missing here:

  • Update r.landscape.evol Markdown to new doc. (It had Markdown before, so that Markdown file was preserved, but it is in a different style than the other Markdown files.)
  • Reduce cases where sh code blocks are used for things which are not sh (code blocks marked as sh which are in fact Python examples or plain text output).

@isaacullah
Copy link
Contributor

isaacullah commented Mar 6, 2025 via email

@wenzeslaus wenzeslaus moved this to In Progress in GRASS Markdown Documentation Mar 6, 2025
@petrasovaa
Copy link
Contributor

Vaclav, what kinds of changes are needed for r.landscape.evol markdown to
come into compliance? I can do this with a little guidance if necessary.

~Isaac

I am not sure either, it is compliant with with setting in the markdown linter. So maybe some of the subheadings could be more semantically correct, e.g. you could remove the numbering from the subheadings and then things like "a) GIS Implementation:" could be "#### GIS Implementation"

@isaacullah
Copy link
Contributor

isaacullah commented Mar 12, 2025 via email

moovida pushed a commit to moovida/grass-addons that referenced this issue Mar 24, 2025
Enable commands-show-output from markdownlint globally, and disable it for the problematic code blocks in r.fuzzy.system.

See also OSGeo#1333 and OSGeo#1334.
@wenzeslaus
Copy link
Member Author

@isaacullah I removed the r.landscape.evol issue from here and moved it to a separate issue.

I'm closing this as completed as all individual todos are now completed.

@github-project-automation github-project-automation bot moved this from In Progress to Done in GRASS Markdown Documentation Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
manual Documentation related issues
Projects
Development

No branches or pull requests

3 participants