Comprehensive documentation for config JSON

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation, frontend

Research direction

Start with the README and inspect how the config JSON is currently represented across the functions and frontend. Document the config JSON spec in the README and establish the requested shared TypeScript class between those areas; done means both use the shared representation and the README describes the spec.

Written by the indexing model from the issue text.

Description

type: docs

The README should show the config JSON spec.

This spec should be a shared TypeScript class between functions and frontend.

Dominant language
TypeScript
Stars
127
Forks
49
No merged PRs in 30d

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 firebase/firebaseopensource.com

All issues in firebase/firebaseopensource.com

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.