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

Please define "stubs" on Dendron Doctor page #677

Open
2 of 18 tasks
jeep opened this issue Oct 24, 2022 · 3 comments
Open
2 of 18 tasks

Please define "stubs" on Dendron Doctor page #677

jeep opened this issue Oct 24, 2022 · 3 comments
Assignees

Comments

@jeep
Copy link

jeep commented Oct 24, 2022

Which docs page should be improved?

https://wiki.dendron.so/notes/ZeC74FYVECsf9bpyngVMU/#removestubs

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

Stubs are defined as "Stubs are notes that don't exist but that you might want to create."
But the Dendron: Doctor command says it removes stubs... that makes no sense to me.
I see a couple possibilities:
A stub doc is any document with frontmatter but no other content - which scares me and I would like to disable this option
or
A stub doc is any document with frontmatter, no other content, and no backlinks this is what I am looking for
or
A stub doc is any document with no content
or
other?

Suggested fix, improvements or additions

No response

@Harshita-mindfire
Copy link
Contributor

Hello @jeep , A stub is a document with only a frontmatter. A stub has an empty body. The below image is an example of a stub.
image

@YannisCS50
Copy link

May this helps you to understand better
SkepticMystic/breadcrumbs#297 (comment)
and the last paragraph of @kevinslin here
https://linen.dev/d/717965437182410783/t/1191582/hi-everyone-i-downloaded-dendron-overnight-and-was-looking-i

@jeep
Copy link
Author

jeep commented Nov 9, 2022

Thanks. I'll leave this open until the doc is updated, but I now understand.

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

No branches or pull requests

5 participants