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

Documentation: Update Custom Pens documentation links #1843

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

tobybaratta
Copy link
Contributor

Issue:

  • The README contains a broken link to a not-on-main file documenting how to add custom pens. (That document was archived.)
  • The README hard-links to the master branch of the EA folder rather than to whatever branch the GH user is on. I have made that link relative, so that when looking at a different branch, the links are relative to the branch the user is searching around on.

Fix:

  • Pens are now handled in settings with a different YouTube video showing how to set them up (I think).
  • Adds links to the Hardware Eraser functionality & Auto Draw for Pen.

Open Question/Discussion:

  • I think it might be useful to link to the freestyle docs here still, or have some sort of master "Alternative Pens" link that still shows how to do the JSON setup as opposed to the UI setup? Not sure if necessary?
  • In terms of pen setup docs, I just see issue Quality of Life Improvement - Optimizing UX for writing with pen #986 (with its screenshot) and of course the video setup. I'm still a beginner on Obsidian stuff but am open to help with writing up some more of the docs that are in YT videos, if that would be helpful to you.

Thanks for all your work! Please let me know if I can answer any questions!

**Problem:**
- The README right now contains a broken link to a not-on-main file documenting how to add custom pens. (That document was archived -- I found the original via searching and tried to find the corresponding PRs for the details on the replacement functionality but couldn't find that PR.) 
- Pens are now handled in settings with a different YouTube video showing how to set them up (I think). 
- Adds links to the Hardware Eraser functionality & Auto Draw for Pen. 

Question:
- I think it might be useful to link to the freestyle docs here still, or have some sort of master "Alternative Pens" link that still shows how to do the JSON setup? Not sure if necessary.
commonmark spec thank you for working with spaces now
@zsviczian
Copy link
Owner

Thanks. Any help with documentation is highly appreciated. Things have changed over time, and I do struggle to keep documentation up to date.

@zsviczian zsviczian merged commit 1b04b94 into zsviczian:master Jul 4, 2024
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.

None yet

2 participants