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

217 docc tutorial sidebar fix #272

Merged
merged 5 commits into from
Nov 29, 2023

Conversation

Jakayus
Copy link
Contributor

@Jakayus Jakayus commented Nov 27, 2023

What it Does

  • Closes BUG - DocC Tutorial Isn't Deployed #217
  • This change adds the tutorial links to the sidebar of the documentation. It also removes the tutorial link from within one of the articles (the previous PR) since it is no longer necessary.

How I Tested

Step 1: Fix and Build Documentation:

  • Use Runestone app documentation as a guide by downloading and building the documentation
  • Open up Basic-Car-Maintenance .MD files and edit for formatting/layout
  • Build Documentation by using Product -> Build Documentation

Step 2: Verify Documentation/Hosting:

  • Commit changes (testing the hosting site adds files that are not to be committed, so this step is important)
  • modify build-docc.sh script and change hosting-base-path to equal an empty string, so --hosting-base-path ""
  • run ./build-docc.sh in local repo directory
  • run /opt/homebrew/bin/python3 -m http.server -d .docs to host documentation on local host
  • run localhost:8000 in private browser to see documenation
  • Verify documentation is working
  • Clean area and push the original commits; otherwise clean area and continue fixing

Notes

  • I was able to host the tutorials in the sidebar by updating the .MD file formatting. I have provided some of the major highlight areas in a screenshot below.
  • MD formatting is extremely picky. Wrong formatting causes issues.
  • The MD formatting tells the documentation to override the default organization of the Xcode build documentation process. It looks like this was needed for the tutorials, and was seen in Runestone's documentation as well.
  • More information on needed MD file formatting can be found in Apple's documentation, in Apple's Adding structure to your documentation page, subsection Arrange top level symbols using topic groups.

Screenshot

Tutorials seen in hosted documentation site.
tutorial_sidebar

Xcode Build Documentation for comparison
xcode_build_doc

MD file significant formatting notes
MD_formatting

Copy link
Owner

@mikaelacaron mikaelacaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!! Thanks for fixing this!

@mikaelacaron mikaelacaron merged commit b1f64bf into mikaelacaron:dev Nov 29, 2023
2 checks passed
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

Successfully merging this pull request may close these issues.

BUG - DocC Tutorial Isn't Deployed
2 participants