Documentation Updates
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- openapi, react
- Domain
- documentation, web-dev
Research direction
Start by reviewing the existing model, schema, ADRs, and roadmap pages linked in the issue to map the current information architecture. The requested work spans navigation, search, user-oriented schema guidance, GitHub links, and roadmap references; done would require agreed scope and success criteria for the selected improvements.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem?
I was walking through the Gemara spec via the website and found it difficult to discover all of the information that I needed to use the spec effectively.
Describe the solution you'd like
Navigation
- I would like to be able to easily view all attributes and relationships of the spec on the website
- A translation from CUE -> OpenAPI -> Docusaurus+React Flow may be a potential solution for a more interactive experience
- I would like to be able to easily search the site
- I expected to be able to drill down into the different layers of the model to be able to see the associated schema materials
Missing Content
- The ADRs page doesn't contain a list of ADRs (maybe there haven't been any)
- When looking at the schema page, it isn't immediately obvious as to when/why I would use parts of the schema. User-oriented flows starting from "what problem does this flow solve" would be great
Nits
- I would suggest placing a GitHub icon link at the top right of the page (I looked for it instinctively to file this ticket)
- If the Roadmap linked back to the driving GitLab issues (or other artifacts) it would be useful for understanding the overall state of things and where I might contribute most effectively
Describe alternatives you've considered
No response
Success Criteria
No response
Additional context
No response
- Dominant language
- Go
- Stars
- 0
- Forks
- 11
- Avg merge
- 22h 49m
- Merged PRs (30d)
- 18
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from gemaraproj/website
-
Define a Cross-Framework Mapping Resolution specificationPossibly taken @ravindra-RKB claimed this 13 days ago. Open
Difficulty 5/5 Over a week Newbie friendliness 15/100
gemaraproj/website#42 · 1 comment ·
Maintainers usually reply within 1 day
-
Define an OCI Bundle Distribution & Packaging specificationMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 5/5 Over a week Newbie friendliness 18/100
gemaraproj/website#41 ·
Maintainers usually reply within 1 day
-
Add a Policy tutorial that uses the Risk CatalogPossibly taken @dannyward630 claimed this 16 days ago. Opendocumentation good first issue help wanted
Difficulty 3/5 1-2 days Newbie friendliness 30/100
gemaraproj/website#34 · 1 comment ·
Maintainers usually reply within 1 day
-
feat: embed gemara-react live demo in the websitePossibly taken @PaarthPandey10 claimed this 18 days ago. Opendocumentation help wanted
Difficulty 4/5 3-5 days Newbie friendliness 55/100
gemaraproj/website#6 · 5 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Add `llms.txt` to rootPossibly taken @jpower432 claimed this 114 days ago. Openkeep
gemaraproj/website#1 · 3 comments · 1 assignee ·
Maintainers usually reply within 1 day
All issues in gemaraproj/website
Similar issues
-
Pin and verify Security Insights schema in lintinsights targetPossibly taken @imshubham22apr-gif claimed this 5 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
gemaraproj/gemara#618 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
a2aproject/a2a-go#597 ·
Maintainers usually reply within 1 day
-
scopes: GetAllowedTopics, GetProtectedTopics, and GetScopedTopics include empty topic names and do not trim whitespace charactersPossibly taken @patelshivani2283-lab claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area/networking kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
siderolabs/talos#14972 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day