Document all features of IE in example documents

Open
#245 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
go
Domain
documentation, testing

Research direction

No files, tests, or entry points are named in the issue. Start by surveying the InnovationEngine implementation and existing example documents, then identify every feature that needs coverage; done means the features are documented and the test suite validates the documented behavior.

Written by the indexing model from the issue text.

Description

documentation

IE should be self-documenting and self-testing. That is every feature in IE should be documented and our tests should run over our documentation to validate expected behaviour.

Dominant language
Go
Stars
40
Forks
27
Avg merge
2d 20h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/InnovationEngine

All issues in Azure/InnovationEngine

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.