bcgov / bcgov/common-hosted-form-service-techdocs

CHEFS examples lack consistency

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
1
Forks
9
Avg merge
19m
Merged PRs (30d)
4

Description

The example forms in CHEFS lack consistency in:
- name of the .JSON files that can be downloaded (`chefs_example__something_something.json`?)
- code shown in the documentation must match what is in the JSON files
- JSON files must match what is deployed in CHEFS
- CHEFS examples should only be owned by CHEFS team
- Examples should not produce console errors, even if it means the JavaScript is more complicated. When less technical users cut and paste from the examples it's more difficult to help them debug if the console is full of errors.

## Definition of Done
- [ ] Update the Style Guide with a description of the naming convention (and anything else) related to examples

Contributor guide

Open the contributing guide

Research direction

Start with the Style Guide and review the existing CHEFS example guidance. Document the naming convention for downloadable JSON examples and any related consistency expectations stated in the issue. Done means the Style Guide contains this description and its checklist item can be marked complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.