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

Help should be inline #110

Open
ujmappa opened this issue Oct 12, 2023 · 3 comments
Open

Help should be inline #110

ujmappa opened this issue Oct 12, 2023 · 3 comments

Comments

@ujmappa
Copy link

ujmappa commented Oct 12, 2023

I saw a lot of times that you link the manual, or some help page how to do this and that. But these helps should be inline with some (?) mark after a field and a description on the page. Before migrating help you should at least link the approptiate manual link on each page that users can access them directly. After migration you will not have to maintain two projects, and you will immediately notice on the page that help should be changed as well.

@Mike-E-angelo
Copy link
Member

Nodding along here. Is there a way to integrate Gitbook into an actual product as you suggest? 🤔

@ujmappa
Copy link
Author

ujmappa commented Oct 12, 2023

No, there isn't, or at least not that I would know of. Maybe you could integrate it as an iframe as first step? But I thought of pure HTML that contains more or less the same content, but on the page. Why would you have two places when help could be inline? It can be a continous thing, but having a separate Gitbook is for sure a bad solution from user perspective, this is not a developer manual, API description, etc.

@Mike-E-angelo
Copy link
Member

GitBook is what Midjourney used and where I got the inspiration. :D I see now visiting their link that they, too, evolved. 👍 I am certainly open to a better solution especially if it's cheap/free and easy to integrate.

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

No branches or pull requests

2 participants