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

[doc] explain truss input file format in documentation #138

Closed
yijiangh opened this issue Jan 30, 2023 · 3 comments
Closed

[doc] explain truss input file format in documentation #138

yijiangh opened this issue Jan 30, 2023 · 3 comments

Comments

@yijiangh
Copy link
Collaborator

No description provided.

@yijiangh yijiangh self-assigned this Jan 30, 2023
@pitipatw
Copy link
Contributor

pitipatw commented Feb 9, 2023

I made a json file to input data from Grasshopper through WebSockets to Julia.
I think I might able to help on this

@yijiangh yijiangh removed their assignment Feb 10, 2023
@yijiangh
Copy link
Collaborator Author

@pitipatw That's awesome! The corresponding page in our doc is here and the source here.

In case you are not familiar with doc generation in Julia, we use Documentor.jl for building the docs (from markdown to HTML files), and we have a make.jl file for triggering the generation.
We also use Literate.jl for turning a .jl file directly into an example documentation. If the comments you write in the example script follows markdown syntax, it will be compiled into a nicely looking webpage with all the outputs rendered (like what you would see in a jupyter notebook).
@pitipatw, I would suggest that you start by adding some comments on the JSON keys and value format in our truss file in the source file here. And maybe remove the print(JSON.json(f, 2)); - I think it is occupying too much space on the doc page.

@pitipatw
Copy link
Contributor

pitipatw commented Feb 10, 2023

Copy that.

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

No branches or pull requests

2 participants