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

Fixed some spelling, grammatical, syntax errors. Improved layout. #13

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

corneels
Copy link

No description provided.

@llaniewski
Copy link
Member

@corneels Thanks for the help. I think mkdocs (with which the documentation is generated) is interpreting that if first few points are numbered, then the rest is numbered even if you do * or -. I think all of them (including the first few) can be bullet points. But it would be great if they would be links.

@llaniewski llaniewski self-assigned this Oct 10, 2019
@corneels
Copy link
Author

corneels commented Oct 10, 2019

But it would be great if they would be links.

@llaniewski would you like these to link to the first item under each subheading? For example, for Installation it would link to 2.-installation/esys-particle/.

Linking to 2.-installation/ would be invalid.

@llaniewski
Copy link
Member

@corneels You're right. This doesn't make sens. Let's not make the titles the links. Maybe it would be good to have the heading bolded, and the links in the text, like:

* **General Info**
    Contains general information related to TCLB, including a list of [publications](/general-info/publications/) that employ TCLB.
  • General Info
    Contains general information related to TCLB, including a list of publications that employ TCLB.

Thanks again for the help.

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

Successfully merging this pull request may close these issues.

2 participants