JuliaFEM / JuliaFEM/MFrontInterface.jl
Use Literate.jl to generate README.md and usage notebook
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 5
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
We should use https://github.com/fredrikekre/Literate.jl for documentation of usage examples.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's existing README.md and usage examples, then read the Literate.jl documentation linked in the issue. Set up Literate.jl to generate README.md and a usage notebook from the examples, and verify that both outputs contain the intended usage documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100