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

New documentation: zd-tutorial #64

Open
EFLS opened this issue Jun 6, 2020 · 9 comments
Open

New documentation: zd-tutorial #64

EFLS opened this issue Jun 6, 2020 · 9 comments
Labels
discussion Discuss practices & share information documentation Add tutorial or documentation feedback wanted Share your experiences with changes & additions

Comments

@EFLS
Copy link
Owner

EFLS commented Jun 6, 2020

I've compiled a set of notes that serves as both a tutorial and a knowledge base.

It's available in this repository: https://github.com/EFLS/zd-tutorial

You should be able to clone it and explore it right away. It even includes installation instructions, so you should be able to start even without having Zetteldeft installed.

Please check it out and let me know whether it is as accessible as I hope it is!

@EFLS EFLS added discussion Discuss practices & share information documentation Add tutorial or documentation labels Jun 6, 2020
@cmorgan
Copy link

cmorgan commented Jun 6, 2020

maybe a bootstrap script so you can experiment with this in parallel with a growing primary zetteldeft?

@EFLS
Copy link
Owner Author

EFLS commented Jun 8, 2020

You can use this in parallel as it is now. What exactly would you include in such a bootstrap script?

@cmorgan
Copy link

cmorgan commented Jun 8, 2020

I guess it would change the deft directory.

@EFLS
Copy link
Owner Author

EFLS commented Jun 8, 2020

Ah yes. Well there is actually a bootstrap script included. Both in the Welcome and in the elaborate README there is code to set Deft to the correct directory.

@EFLS EFLS pinned this issue Jun 11, 2020
@EFLS EFLS added the feedback wanted Share your experiences with changes & additions label Aug 11, 2020
@TRSx80
Copy link

TRSx80 commented Aug 25, 2020

I like it! Lots of good background, etc. And I like the "dogfooding" aspect as I think they call it (using your own product to demonstrate/promote itself).

At first I thought I would add a few more notes in here about my modifications on top of Zetteldeft, but as I am doing more straight "Org" oriented stuff (mainly links) and not using your beloved "§" symbol, perhaps my own little repo / package / gist might be a more appropriate place.

All my stuff is still very WIP anyway, I am just thinking ahead.

Also, I think I bothered you enough today, maybe time to go do something else for a bit. 😄 I'm just really excited about my personal notes again, in a way I haven't been in a very long time. So thanks, again, for that. 🍻

@EFLS
Copy link
Owner Author

EFLS commented Aug 25, 2020

I'm just really excited about my personal notes again, in a way I haven't been in a very long time. So thanks, again, for that.

Great to hear, that's what its all about! I'll take a look at your other suggestions when I've got some more time over the next couple of days.

@TRSx80
Copy link

TRSx80 commented Aug 25, 2020

Yeah, don't mind me. I am just on a roll today. 😄

Absolutely no rush, whenever you have time. I just happen to have some at the moment, hence the outpouring of ideas.

Cheers! 🍻

@mediapathic
Copy link

This is great! Would you be interested in additions to this of examples for specific workflows, along the lines of #104 ? I've done a bunch of hacking to make zetteldeft work with various other past systems, and I could maybe write something up if you'd like. That may be too esoteric for the core repo though.

@EFLS
Copy link
Owner Author

EFLS commented Feb 12, 2021

Yeah good idea. Try to make your suggestions "generic" (i.e., not too specific for your single use case), and they can surely be useful for the zd-tutorial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discuss practices & share information documentation Add tutorial or documentation feedback wanted Share your experiences with changes & additions
Projects
None yet
Development

No branches or pull requests

4 participants