search

sailfishos / sailfish-components-webview

Mozilla Public License 2.0
13 stars 23 forks source link

Documentation is not a tree but a forest #158

Open thigg opened 2 years ago

thigg commented 2 years ago

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 commented 2 years ago

Also add documentation about the CORS flags

llewelld commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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