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

all modules, keywords, pragmas should be indexed and searchable #17493

Closed
timotheecour opened this issue Mar 24, 2021 · 1 comment
Closed

all modules, keywords, pragmas should be indexed and searchable #17493

timotheecour opened this issue Mar 24, 2021 · 1 comment
Labels
Documentation Generation Related to documentation generation (but not content).

Comments

@timotheecour
Copy link
Member

timotheecour commented Mar 24, 2021

bug 1: search box gives no hits

the search box in https://nim-lang.github.io/Nim/lib.html gives no hits for these:

bug 2: theindex.html gives no hits

https://nim-lang.github.io/Nim/theindex.html gives no hits for:

  • prelude

bug 3: lib.rst is incomplete and should be automatically checked for completeness

we should trigger a CI error if a stdlib module is missing from lib.rst (https://nim-lang.github.io/Nim/lib.html)
we can maintain a (small) blacklist of modules that should not be mentioned there, if needed.

for example:

bug 3: master index + per-package indexes

there should be a page where we index all modules in nim repo (or more generally in some git repository with multiple nimble packages).

each index has its own page, with a theindex.html and corresponding search box; we almost have that already:

we can have:

  • 1 master index for all modules
  • 1 index for stdlib (as we currently do except some are missed, see bug 1)
  • 1 index for compiler (we already do, nothing to do there)
  • 1 index for fusion (we already do, nothing to do there)
  • 1 index for tools (missing)
  • 1 index for nim keywwords/pragmas/etc (missing; see bug 5)

bug 4 (easy)

in https://nim-lang.github.io/Nim/lib.html#pure-libraries-automatic-imports,

  • channels is wrong, it should be channels_builtin

bug 5: nim language index

we also need a language index, where you can search for builtin pragmas (eg: inject), keywords (eg: template, proc, tokens (eg: """, ' etc)

just as all other indexes (stdlib, compiler, fusion) it'd have it's own index, and would also be searchable in the master index

the index href would point to wherever the term is defined (most likely to an entry in the manual), possibly via a :idx: link

Additional Information

1.5.1 28221e8

ideally these should be fixed with a generic approach that works with other repositories, not use hard coded lists

@timotheecour timotheecour added the Documentation Generation Related to documentation generation (but not content). label Mar 24, 2021
@Araq
Copy link
Member

Araq commented Aug 27, 2023

Whatever.

@Araq Araq closed this as completed Aug 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Generation Related to documentation generation (but not content).
Projects
None yet
Development

No branches or pull requests

2 participants