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

docs: General todos for Markdown #5162

Open
6 of 14 tasks
wenzeslaus opened this issue Feb 20, 2025 · 1 comment
Open
6 of 14 tasks

docs: General todos for Markdown #5162

wenzeslaus opened this issue Feb 20, 2025 · 1 comment
Labels
docs manual Documentation related issues markdown Related to markdown, markdown files Python Related code is in Python
Milestone

Comments

@wenzeslaus
Copy link
Member

wenzeslaus commented Feb 20, 2025

This is a general todo list for the new documentation which originally lived in #3849 (I transferred the unresolved todos only). Feel free to add more basic issues here, but use smaller issues and the project for specific tasks if possible rather than turning this into a un-closeable mega issue.

Needed

Notes on man:

-$(MANDIR)/%.$(MANSECT): $(HTMLDIR)/%.html
+$(MANDIR)/%.$(MANSECT): $(MDDIR)/source/%.md

Nice to have

Future

  • revise usage of keywords and tags from user perspective (what should a reader see)
  • revise usage of keywords and tags from implementation perspective (valid YAML syntax and duplication)
  • revise or clean up the graphical index (index pages) - drop it or make it the only index pages
  • remove reStructuredText-related code and scripts (aka rest or rst)
  • remove HTML documentation files
  • remove custom HTML documentation from build system and build scripts
@wenzeslaus wenzeslaus added docs manual Documentation related issues markdown Related to markdown, markdown files Python Related code is in Python labels Feb 20, 2025
@wenzeslaus wenzeslaus changed the title docs: docs: General todos for Markdown Feb 20, 2025
@neteler neteler added this to the 8.5.0 milestone Feb 21, 2025
@cwhite911 cwhite911 moved this to In Progress in GRASS Markdown Documentation Feb 21, 2025
@cwhite911
Copy link
Contributor

main index: choose better formatting than the current table

I have an idea for this one, but it will be easier just to show in a draft PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs manual Documentation related issues markdown Related to markdown, markdown files Python Related code is in Python
Projects
Status: In Progress
Development

No branches or pull requests

3 participants