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: Add sections for missing blockTypes #388

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Conversation

Lehmanator
Copy link
Contributor

Add sections to "Builtin Block Types" for each blockType without one.

Fixes: #386 (partially)

  • Matches existing sections by inserting the contents of the file with the blockType definition.
  • Fixes typo in comment in blockTypes.nvfetcher definition file.

If desired, I'd also like to:

  • Alphabetize the blockType sections (or order according to another scheme)
  • Remove the comment strings from the blockType definition files and add them to the documentation.
  • Create example definition files for each blockType and add them to the docs.

I could do this in another PR if out of scope for this one.

@blaggacao
Copy link
Collaborator

blaggacao commented Jul 30, 2024

Alphabetize the blockType sections (or order according to another scheme)

👍

Remove the comment strings from the blockType definition files and add them to the documentation.

👎 There are indeed folks for whom the documentation is secondary, think of workflows using lsp "jump to definition", even if not currently possible with nix, approximatable with rg/grep

Create example definition files for each blockType and add them to the docs.

👍 💯

@blaggacao blaggacao merged commit f8f6f70 into divnix:main Jul 30, 2024
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for blockTypes
2 participants