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 is not a tree but a forest #158

Open
thigg opened this issue Mar 18, 2022 · 6 comments
Open

Documentation is not a tree but a forest #158

thigg opened this issue Mar 18, 2022 · 6 comments

Comments

@thigg
Copy link

thigg commented Mar 18, 2022

At least the sailfish-webview-webviewadditional.qdoc site does not seem to be linked anywhere else in the documentation. I just found it via some search voodoo with a duck. (I was searching for the documentation of onRecvAsyncMessage and addMessageListener)

Flypig hat in the community news a very good piece that might be worth adding to the documentation.

@thigg
Copy link
Author

thigg commented Mar 18, 2022

Also add documentation about the CORS flags

@llewelld
Copy link
Member

At least the sailfish-webview-webviewadditional.qdoc site does not seem to be linked anywhere else in the documentation.

We did very recently add a link from the docs site to the WebView documentation. Is that the kind of thing you were thinking of?

We're always looking for ways to improve the navigability of our documentation forest of course, so please do submit a PR to docs.sailfishos.org if you can see some nice way to make it easier to find things.

Also add documentation about the CORS flags

Yes, a good point, we should add that here.

@poetaster
Copy link

poetaster commented Mar 18, 2022

Now if only I could find that in the repo! I just looked in a fresh fork at https://github.com/poetaster/docs.sailfishos.org ... Am I being thick?
Edit: I think I grokked. The links in the .md in /Develope/Apps are to auto-generated docs which are part of the SDK?

@llewelld
Copy link
Member

Which repo/part do you mean exactly? If it's a page on docs.sailfishos.org and you have the page itself, the easiest way to find it in the repo is to hit the "Edit this page" link at the bottom of the page.

@poetaster
Copy link

poetaster commented Mar 18, 2022

Which repo/part do you mean exactly? If it's a page on docs.sailfishos.org and you have the page itself, the easiest way to find it in the repo is to hit the "Edit this page" link at the bottom of the page.

I found the readme.md in Apps but I failed to find the source of: https://sailfishos.org/develop/docs/sailfish-components-webview/

It's odd. Although the text WebView can be found, github's search does not find that text. strange!

@thigg
Copy link
Author

thigg commented Mar 18, 2022

yeah also noticed today that github search doesnt find stuff thats obviously there

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

3 participants