Repository navigation
Updates to the how-to guide for creating the config - #50
Open
TeresiaOlsson wants to merge 16 commits into
Open
TeresiaOlsson wants to merge 16 commits into
TeresiaOlsson wants to merge 16 commits into
Conversation
… also includes dictionary.
…nfiguration differs from building objects yourself.
…nfiguration explanation.
…e since the dictionary option also exist.
Member
|
For me a how-to guide is how to set-up a minimal working exemple, so I would avoid adding too many advanced concept in this page, but rather adding new pages for these concepts. |
GamelinAl
reviewed
Sep 25, 2026
GamelinAl
reviewed
Sep 25, 2026
Member
|
@TeresiaOlsson I updated the doc with the changes we discussed, tell me if it's good for you |
Member
Author
I will take a look at it tomorrow :) |
This branch has not been deployed
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
2 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 have updated the content of the how-to guide for the configuration.
Some parts in it was wrong (for catalogs and validation) but otherwise I mostly added links and moved some things around to improve the readability and flow.
Things I found are missing that we should add:
What to do if you don't have unique names in your lattice but family names. This is easy and I think just a sentence is needed but I'm not sure about the current option so I didn't add it.
Difference between validation of configuration and validation during object creation. This is content that I need to add at other places since it's currently completely missing from the documentation. There are also some default options that needs to be changed at some places which I have assigned issues for but done yet.
A link is needed to documentation for the test lattice. To generate documentation for that package is also an existing issue.