Skip to content

[Question] Are you open to user contributed documentation? #1228

@jamesdoran

Description

@jamesdoran

Fork is an excellent tool with a deep set of features - I love it! However, discovering how those features work can be difficult.

  • There's no help packaged with the software
  • There's no documentation on fork.dev
  • The keyboard shortcuts links to issue Fork Keyboard Shortcuts #333 which somone created and contains other 'noise'
  • The release notes are great, but there's no explanation on how to use new features

I'm wondering if you'd be open to making use of the github wiki feature and accepting PRs to build out documentation?

Activity

DanPristupov

DanPristupov commented on Jul 8, 2021

@DanPristupov
Contributor

However, discovering how those features work can be difficult.

Usually all features are available in the corresponding context menus. We don't have separate docs because they would either say 'open context menu' or duplicate the git-scm docs which is great.

The keyboard shortcuts links to issue Fork Keyboard Shortcuts #333 which somone created

Well, this person is the developer of Fork :).

and contains other 'noise'

Yeah, you are right. We should probably limit the conversation there.

The release notes are great, but there's no explanation on how to use new features

Can you give some examples? In my opinion, the only feature which might not be straightforward is custom commands.

I'm wondering if you'd be open to making use of the github wiki feature and accepting PRs to build out documentation?

I think we can try. Or at least start with the FAQ and Keyboard Shortcuts sections.

jamesdoran

jamesdoran commented on Jul 8, 2021

@jamesdoran
Author

Thanks for getting back to me @DanPristupov. What I was trying to say (and failed) was that you're adding incredibly useful and thoughtful new features, but they're "hiding" behind a line item in the "what's new" popup after an upgrade.

I know it's a little more work, but it would be incredibly useful to see small gif videos as part of the release notes (if not super simple). For example, the new feature of highlighting certain user's commits was listed as a feature, but I couldn't find how to use it (probably me being stupid, but that's another story). An animated gif showing it in action would have made it obvious.

It would be great if you could create a FAQ page though, thank you.

DanPristupov

DanPristupov commented on Jul 9, 2021

@DanPristupov
Contributor

Alright, I created a separate repository for Docs: https://github.com/fork-dev/Docs. It's empty now, but I'll try to add some basic pages this weekend.

And since we are here...

the new feature of highlighting certain user's commits was listed as a feature, but I couldn't find how to use it

Screen.Recording.2021-07-09.at.11.32.56.mov
jamesdoran

jamesdoran commented on Jul 10, 2021

@jamesdoran
Author

Fabulous - thanks. The screen recording is excellent. Looks like a neat feature.

carun

carun commented on Jul 12, 2021

@carun

@DanPristupov thanks for the screencast. How do we reset the author color?

Otiel

Otiel commented on Jul 12, 2021

@Otiel

Click on the selected color - a small cross appears on the icon.

image

carun

carun commented on Jul 12, 2021

@carun

@Otiel thanks. My questions about resetting the color. In other words, to remove the newly applied color so as to reset to it's original state.

carun

carun commented on Jul 12, 2021

@carun

Ah, it is actually a toggle button. Clicking on the x removes the color. It will be good to have this covered in the wiki, of course.

jamesdoran

jamesdoran commented on Jul 12, 2021

@jamesdoran
Author

The new pages are looking great. Thanks @DanPristupov.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @carun@DanPristupov@jamesdoran@Otiel

        Issue actions

          [Question] Are you open to user contributed documentation? · Issue #1228 · fork-dev/TrackerWin