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

Move API documentation to doxygen.librepcb.org? #22

Closed
ubruhin opened this issue Sep 10, 2018 · 4 comments
Closed

Move API documentation to doxygen.librepcb.org? #22

ubruhin opened this issue Sep 10, 2018 · 4 comments

Comments

@ubruhin
Copy link
Member

ubruhin commented Sep 10, 2018

https://docs.librepcb.org is intended for user documentation. But is API documentation for users? Basically a user could also be interested in writing a script or so which fetches the list of available libraries from our server. But probably most users don't access the API directly, so I wonder if we should move the API documentation to our developers documentation at https://doxygen.librepcb.org to keep users documentation clean.

Actually I already gave it a try 😉, see https://doxygen.librepcb.org/_branches/add-api-documentation/d1/dcb/doc_server_api.html

Any thoughts?

EDIT: Actually the API specification is somehow similar to the file format specification, which is also documented at https://doxygen.librepcb.org...

@dbrgn
Copy link
Member

dbrgn commented Sep 11, 2018

Yeah makes sense :)

By the way, I think it would be good to rename the subdomain from "doxygen" to something like "dev" or "developers". It's much more than just class documentation, and I keep forgetting that 🙂

@ubruhin
Copy link
Member Author

ubruhin commented Sep 16, 2018

By the way, I think it would be good to rename the subdomain from "doxygen" to something like "dev" or "developers"

Hmm yeah I can do that (the old domain could then be redirected to the new one to avoid dead links).

@dbrgn
Copy link
Member

dbrgn commented Sep 16, 2018

old domain could then be redirected to the new one to avoid dead links

HTTP 301 Moved Permanently 🙂

@ubruhin
Copy link
Member Author

ubruhin commented Sep 16, 2018

HTTP 301 Moved Permanently

Yep 😃

@ubruhin ubruhin closed this as completed Sep 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants