JuliaFEM / JuliaFEM/juliafem.github.io
Make documentation more visible
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 3
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
It should be easy to access documentation. There should be some sort of search box and when user wants to find out what function X does and how to call it, after writing function name to search box and click "search" it should be clear in 30 seconds.
Contributor guide
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 inspecting the Jekyll-generated website and its Markdown documentation to determine how documentation pages are organized. Done means users can search for a function name, find what it does and how to call it, and understand the result within 30 seconds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100