Open
Conversation
Denperidge
approved these changes
Jul 27, 2023
Contributor
Denperidge
left a comment
Denperidge
left a comment
There was a problem hiding this comment.
I have no jurisdiction outside of being our company's documentation girl, but as far as my approval goes; it looks good!
Member
|
@Denperidge how does this work on the semantic.works site? do you know? |
Contributor
|
@nvdk 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 |
If you're reading this trying to figure out why this link doesn't work, maybe the [pull request](mu-semtech/project#5) hasn't been merged yet. In which case, you want to look here: https://github.com/Denperidge-Redpencil/docs-update-project/blob/master/docs/how-tos/troubleshooting---slow-starting-containers.md
If the why-semantic-tech link does not work, please see https://github.com/Denperidge-Redpencil/du-project/blob/master/docs/discussions/why-semantic-tech.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.