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

[doc] Make the link to documentation shorter and memorizable? #14

Closed
archibate opened this issue Oct 11, 2020 · 4 comments
Closed

[doc] Make the link to documentation shorter and memorizable? #14

archibate opened this issue Oct 11, 2020 · 4 comments

Comments

@archibate
Copy link
Collaborator

Shall we move:
https://taichi.graphics/versioned_docs/develop/documentation/advanced/meta.html
to:
https://taichi.graphics/docs/develop/advanced/meta.html

@rexwangcc
Copy link
Contributor

I think that's a good idea. Actually I was hisitated about using versioned_docs initially since it's too long. The only concern is that if:

- https://taichi.graphics/versioned_docs/develop/documentation/advanced/meta.html
+ https://taichi.graphics/docs/develop/advanced/meta.html

will make the doc writers a bit more confusing about where to go to write docs, since the URL is bond to the file structure, which means all stuff under website/docs/versioned_docs will be moved to website/docs/docs.

@archibate
Copy link
Collaborator Author

archibate commented Oct 14, 2020

So why not just move /website/docs/src to /src?

@rexwangcc
Copy link
Contributor

So why not just move /website/docs/src to /src?

Sounds good, we could look into it, especially before more docs come in.

We didn't go with a more flat structure simply because the vuepress scaffold made some decisions around the layout, see "VuePress follows the principle of "Convention is better than configuration". "

@rexwangcc
Copy link
Contributor

Resolved by #15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants