Code Monkey home page Code Monkey logo

Comments (3)

WerWolv avatar WerWolv commented on May 30, 2024

Hey!
You're right of course, however there are links available in quite a few places. First there's a link almost at the top of the Readme:
image

Then there's two links on the welcome screen, the page that's first displayed when opening ImHex:
image

Lastly there's a link in the Help Menu as well as a search bar to directly "Ask" the documentation certain questions:
image

The interactive tutorial and also the Achievements both point you towards that option as well. Is there any place where you'd have expected links to the Documentation instead? I'm happy to make it more obvious if it's hard to find but it's definitely mentioned in a few locations.

from imhex.

paxcut avatar paxcut commented on May 30, 2024

also here
image

from imhex.

s-ilent avatar s-ilent commented on May 30, 2024

Yeah. I think having links in the application is good, but it's easy to overlook them. Banner blindness is a common thing even among programmers.

For instance, the badge in the readme is grouped together with various statistics. Other elements of that group like plugins, code statistics, and downloads, are available from elsewhere on the page. Plus, the badge is an image, so it isn't searchable or translatable.

Once loaded into the application, ImHex is easy to use and laid out in a familiar way. ...Which means it's possible to jump into the application and immediately begin using it without committing the contents of the splash screen to memory.

Personally I find a lot of useful tools have a menu structure like "Help > About"... so I never think to check the Help menu for documentation.

When I look for documentation on a tool, I typically open the readme and scroll through it. I think this it's good to use this convention. Even for bigger projects, if the instructions aren't part of the readme itself, they're normally just linked to. i.e. Godot;

Documentation and demos - The official documentation is hosted on Read the Docs. It is maintained by the Godot community in its own GitHub repository.

So I think it would be good to add a section to the readme that just links to the documentation, similar to how the info on contributors, patterns, and plugins is presented. Of course, the problem is me not seeing the obvious signs and sticking to a behavioral pattern, but I think that's just a problem with being human.

from imhex.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.