DEV Community

loading...

Discussion on: Do you use subdomains?

Collapse
ezzabuzaid profile image
ezzabuzaid

interesting.
the docs subdomain is for API docs?

Collapse
daviddalbusco profile image
David Dal Busco

I mostly do frontend work so a general docs or dedicated to the components but, yes I would say documenting the API would be a good fit, I guess. What do you think?

For example that's the docs of one of my side project.

Thread Thread
ezzabuzaid profile image
ezzabuzaid

I'm in process of writing documentation for a frontend project and it is hosted on a virtual directory now, but will change it soon to a subdomain. thanks for your tip.

For backend projects, I don't think using docs as a subdomain for API IMO is a good idea because of versioning, you'll end up having different levels of subdomains like docs.v1.example.com.

Of course, it depends on how the project is structured.

Usually, I use subdomains for self-hosted projects and to create dedicated environments like dev.example.com
testing.example.com

Thread Thread
daviddalbusco profile image
David Dal Busco

For api versioning you make a good point, I am agree with you.

It probably depends how it should be handled. It it has to appear in the URL, with sub-subdomain that ain't readable, fully agree, but, if the version is for example a state of the docs (like for example on date-fns) then I guess "docs" can still be use. Depends of the documentation UX I guess then.

dev.example / testing.example I do that too.

Thanks for your feedback!