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

Tutorial #12

Open
wants to merge 12 commits into
base: feature/with-full-readme
Choose a base branch
from
Open

Conversation

piemonkey
Copy link

I've split the tutorials out to their own file as the README.md seems very unwieldy. The resulting TUTORIALS.md is still unwieldy but this way allows for other content to be added to the readme without it being lost under tutorials.

If we want to keep everything in one large file, we can either trivially re-work the commits or just pull the separate file back into the readme.

This now includes the https://mu.semte.ch/getting-started/ tutorial in the tutorials here, so there's no longer a jump to having an ember UI with no explanation, as well as many small tweaks and a troubleshooting section for the file-limits problem.

Copy link
Contributor

@Denperidge Denperidge left a comment

Choose a reason for hiding this comment

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

I have no jurisdiction outside of being our company's documentation girl, but as far as my approval goes; it looks good!

README.md Outdated Show resolved Hide resolved
@nvdk
Copy link
Member

nvdk commented Sep 11, 2023

@Denperidge how does this work on the semantic.works site? do you know?

@Denperidge
Copy link
Contributor

@nvdk
The current semantic.works/tutorial does not work as is; and I'm afraid that even if you go to docs and mu-project, it only grabs the README.md.

The semantic.works rework should be easily adaptable to a new structure! Tutorials is currently rendered IN IT by grabbing the mu-project repo object, getting its newest revision, and then loading the markdown string from repo-revision.tutorials. It should still load, and perhaps we could stringify a json dictionary of TUTORIAL_NAME: MARKDOWN_STRING

@piemonkey piemonkey changed the base branch from master to feature/with-full-readme October 17, 2023 09:37
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.

3 participants