Point other documentation to the slint language reference #2173
Conversation
This file contains 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
tronical
reviewed
Feb 1, 2023
tronical
reviewed
Feb 1, 2023
| @@ -37,10 +37,6 @@ Welcome to Slint C++'s documentation! | |||
|
|
|||
| genindex | |||
|
|
|||
| language.rst | |||
|
|
|||
| markdown/debugging_techniques.md | |||
There was a problem hiding this comment.
Why did you remove the debugging techniques file?
There was a problem hiding this comment.
I moved it into the language reference.
tronical
reviewed
Feb 1, 2023
tronical
reviewed
Feb 1, 2023
Add a simple index.html to the docs area and link to the supported languages from there.
For node and cpp, I use relative links to point to the slint language reference documentation. For the slint crate documentation I create a link to https://slint-ui.com/releases/VERSION/... instead: This needs to work from docs.rs as well as from our own docs area on slint-ui.com! That is pretty ugly: I can not even define constants for this as the crate docs need to come before anything else.
|
The Debugging section is back where it came from, the index page also links to the tutorials. I'd like to merge this next week (if nothing comes up) to test it live. |
tronical
approved these changes
Feb 2, 2023
|
Looking forward to trying this, too :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Note: Before this can be merged we need to bump the version number and add a redirect to our website!
The
slintcrate documentation creates a full link to the web site, so that it does not break on docs.rs. That link contains the crate version (currently 0.3.4), so it does not work right now as the 0.3.4 release does not come with the slint mdbook.C++ uses relative links and is fine.
NodeJS picked the README.md, which is also used on github. I deduplicated that use by copying the README.md to cover.md, adding a relative link to the slint manual there.