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

Links broken in cFE Application Developers Guide from broken code highlighting #1421

Closed
royerboat opened this issue Apr 26, 2021 · 1 comment · Fixed by #1491 or #1508
Closed

Links broken in cFE Application Developers Guide from broken code highlighting #1421

royerboat opened this issue Apr 26, 2021 · 1 comment · Fixed by #1491 or #1508
Labels
community Community contribution, YAY! docs This change only affects documentation.
Milestone

Comments

@royerboat
Copy link

Describe the bug
The links at the top of the cFE Application Developers Guide on the main branch quit working after heading 6.7. This seems to be caused by an extra character added to the closing code highlighting marks, which you can see here: 2af49e3#diff-1d63579569d1325687a1bfdbfe8c660e157ce1387c41dc3b015f38d006347eaaR2036

Note that the format of the document is also messed up because it highlights normal text as code and vice versa after section 6.7.

To Reproduce
Steps to reproduce the behavior:

  1. Open up the cFE Application Developers Guide on the main branch on Github
  2. Click on the heading for 6.8 in the table of contents.
  3. It doesn't scroll down to that heading for you.

Expected behavior
The link for section 6.8 should take me to that section and the document should not have flipped highlighting in section 6.8 and beyond.

Code snips
None

System observed on:
Use Github to view the file

Additional context
None

Reporter Info
Jeffrey Royer, JSC ER6

@skliper skliper added the docs This change only affects documentation. label Apr 26, 2021
@skliper skliper added this to the 7.0.0 milestone Apr 26, 2021
@astrogeco astrogeco added the community Community contribution, YAY! label May 11, 2021
@astrogeco
Copy link
Contributor

Good find! Thanks @royerboat !

astrogeco pushed a commit that referenced this issue May 19, 2021
The code block didn't terminate properly, causing the markdown to not render correctly on GitHub.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community contribution, YAY! docs This change only affects documentation.
Projects
None yet
3 participants