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

Table of Contents in guideline, left menu #99

Open
kensei-te opened this issue Jun 3, 2022 · 5 comments
Open

Table of Contents in guideline, left menu #99

kensei-te opened this issue Jun 3, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@kensei-te
Copy link
Collaborator

I think it is better to have a menu on left, that provides a link to long long main text, so that readers will not get lost. What I think it is good to be the link is like this:
スクリーンショット 2022-06-03 11 10 50

@lfoppiano Can you make such a link on the left side?

@lfoppiano
Copy link
Owner

We cannot do that with the normal Markdown, however we could have the menu on the side using readthedocs..

e.g. http://supermat.readthedocs.io

@kensei-te
Copy link
Collaborator Author

ah yes, this is what I want.... if we can move easily. Do you think you can make readthedocs?

@lfoppiano
Copy link
Owner

Yes, I can set it up

@lfoppiano
Copy link
Owner

lfoppiano commented Jun 9, 2022

Just one thing, for having readthedocs (free version) working properly we need this project to be public, so for the time being we need to find an alternative solution.
One relatively simple solution would be to having it accessible on falcon for the time being, till we publish supecon2 code and sources. Would that be OK?

@kensei-te
Copy link
Collaborator Author

Just one thing, for having readthedocs (free version) working properly we need this project to be public, so for the time being we need to find an alternative solution. One relatively simple solution would be to having it accessible on falcon for the time being, till we publish supecon2 code and sources. Would that be OK?

I see. I think it is ok to keep it in falcon. (though I still do not know exactly how it works)

@lfoppiano lfoppiano added the documentation Improvements or additions to documentation label Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants