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

Documentation is in a flat file structure

Open
#1 3 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 documentation in the Wiki was had all the files in one directory. This should be cleaned up and organized into a tree of directories that are organized in some logical way.

## Definition of Done:
- [ ] Create a Style Guide
- [ ] Add a file naming convention to the Style Guide and strictly follow it
- [x] Organize all files reachable from the nav or index.md into a tree file structure
- [ ] Figure out what to do with files not reachable from the nav or index.md (include or delete)
- [x] Ensure that all links between files are updated and working correctly, including breadcrumbs

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Wiki files reachable from nav or index.md and the current navigation structure. Define the file tree and naming convention in a Style Guide, then decide whether unreachable files should be included or deleted. Done means the documentation is organized, all links and breadcrumbs work, and the remaining checklist items are complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.