Comments (3)
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:
Then there's two links on the welcome screen, the page that's first displayed when opening ImHex:
Lastly there's a link in the Help Menu as well as a search bar to directly "Ask" the documentation certain questions:
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.
from imhex.
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)
- [Feature] Retain last search string even if the form was closed
- [Bug] Saving a file doesn't work properly HOT 1
- [Bug] Do not allow opening the same file again
- [Bug] Processing Advanced Data Information fails HOT 1
- [Bug] Import menu disabled on read-only files HOT 2
- [Bug] Auto-load supported pattern not working anymore
- [Feature] Reload file button HOT 2
- [Feature] Selection size HOT 1
- Add exception stacktraces HOT 1
- [Bug] Scroll position when moving or selecting bytes down in hex editor using arrow keys HOT 3
- [Bug] "Save As..." Modifies Both the New File and the Original File HOT 1
- [Bug] Data loss, because confirmation dialog logic is inverted
- [Bug] Invalid loop sized array segfault
- [Bug] Endian pragma ignored HOT 3
- [Bug] Bookmarks highlighting is not updating
- [Feature] Open file from CMD and auto go to offset
- [Feature] LZ4 Compressed Bytes HOT 3
- [Bug] Denying server contact in initial wizard still keeps crash reports uploads enabled HOT 1
- [Bug] Setting base address causes Data Inspector and copying issues
- [Bug] Ctrl+G results selection lost after closing GoTo window with Escape
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from imhex.