docs

[JoaoPedroAS51]

Add new docs using Nuxt Content.

See preview in: https://joaopedroas51.github.io/vue-api-query

[Peter-Krebs]

I have added some comments, please reply when you have time.
In general I welcome the changes - but I would like you to clarify some nitpicks of mine (see comments).

Thank you.

[JoaoPedroAS51]

@Peter-Krebs I see that your concerns are about the tags I used and navigation. So I guess you haven't seen the preview link. Please, check it: https://joaopedroas51.github.io/vue-api-query

I'll mark the conversations about tags and navigation as resolved.

[JoaoPedroAS51]

@Peter-Krebs This PR add a documentation website using Nuxt Content.
You can read more about it at: https://content.nuxtjs.org/

[JoaoPedroAS51]

@Peter-Krebs If you're curious about how to publish the website:
I added a Github Action to automatically publish the documentation when the code is merged to master branch. It will build the dist files and push them to gh-pages branch, which is used by Github Pages.

[Peter-Krebs]

So I guess you haven't seen the preview link. Please, check it: https://joaopedroas51.github.io/vue-api-query

Ok that flew past me, sorry. I can see why you need the HTML tags then, I apparently never worked with a package using github.io.

This README file already have HTML tags at the top for the badges and the image.

Yes that's how marketing ruins the pure MarkDown syntax. It's not a criticism against you, I just like to reduce the HTML to a minimum where possible.

I just added "read documentation" based on nuxt auth readme. But I agree that it's kind of invisible here.

The link on the nuxt auth page is pretty missable as well I find. It's not a huge problem, but strictly speaking we shouldn't have important things above the first headline.

[JoaoPedroAS51]

@Peter-Krebs I added a section "links", which includes the documentation and release notes. What do you think? 😃

[JoaoPedroAS51]

@Peter-Krebs

Yes that's how marketing ruins the pure MarkDown syntax.

Yeah, I agree!

The link on the nuxt auth page is pretty missable as well I find. It's not a huge problem, but strictly speaking we shouldn't have important things above the first headline.

Looking at it again now and I agree with you. I'll update the README of auth module too.

[Peter-Krebs]

Nicely done, looking good now!