search

segler-alex / radiobrowser-api-rust

radio-browser API implementation in rust
GNU Affero General Public License v3.0
230 stars 96 forks source link

Documentation #132

Closed An7ar35 closed 2 years ago

An7ar35 commented 2 years ago

Basic markdowns from the original documentation made for use with slatedocs along with a few extras.

Still needs a bit more but created the PR so @segler-alex can review/comment with more granularity.

An7ar35 commented 2 years ago

@segler-alex All JSON, XML, CSV, M3U and PLS code added where appropriate now.

I can remove the slatedocs code leaving only the settings file, logo and markdown if you'd like since, I assume, you will likely pull that in its own repo as per their documentation.

Let me know if you want anything edited/added. Cheers.

segler-alex commented 2 years ago

thanks for all your work!!!

how do i create the docs?

segler-alex commented 2 years ago

i think i can remove mdbook dependency again, correct?

An7ar35 commented 2 years ago

My pleasure!

Using docker: either pull the docker image or create it (see link for more details) then just run the generator from the docs/ directory (see example cmd inside the docker_run.sh file I added in docs/).

Yes, mdbook can go now as far as I'm aware.

segler-alex commented 2 years ago

i think this section is missing: "Example XSPF playlist with extension field" could you add this as well?

An7ar35 commented 2 years ago

i think this section is missing: "Example XSPF playlist with extension field" could you add this as well?

My bad. Documentation #136 PR created.