-
Notifications
You must be signed in to change notification settings - Fork 61
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
docs: Initial setup of documentation website. #234
Conversation
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Codecov Report
@@ Coverage Diff @@
## develop #234 +/- ##
===========================================
- Coverage 98.56% 98.54% -0.02%
===========================================
Files 50 50
Lines 5710 5712 +2
===========================================
+ Hits 5628 5629 +1
- Misses 82 83 +1
Continue to review full report at Codecov.
|
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need a small change in the doc for trestle merge
to take only -e instead of -f and -d. I will make changes in the spec through the #295 .
docs/cli.md
Outdated
|
||
would merge the properties inside each of the files passed in via the `-f` option to the destination file specified with the `-d` option. | ||
|
||
In the near future, trestle merge should be smart enough to figure out which json files contain the elemenets that you want to be merged as well as the destination file that the elements should be placed into. In that case, both `-f` option and `-d` would be deprecated and the commands would look like: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For trestle merge
, we have reached near future 😄 We don't need the -f or -d, but we need -e model.submodel
, where submodel is merged into the model.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Chris Butler chris@thebutlers.me
Types of changes
This is an initial setup for a documentation website as described in #83. Given the complexity of our current build process I've chosen so far the simplest possible path - that is a github 'project page' (as opposed to an organizational page OR read the docs).
Note that some of the api docs will not be resolved correctly until the models are updated in #233 to produce the cleanest possible outcomes.
NOTE: Draft at this stage and expecting substantial feedback will be required to get this where we want it to be.