Add environment configuration documentation #104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated README.md to include guidelines on using and understanding environment configuration files (environment.ts, environment.staging.ts, environment.prod.ts). The documentation covers file purposes, environment selection process, key features, and basic usage guidelines. #103
rngadam
suggested changes
Jan 23, 2024
| @@ -1,8 +1,112 @@ | |||
| # TS-AppVersion Readme | |||
|
|
|||
| TS-AppVersion is a package designed to extract version information from a project's package.json and Git (if configured) and save it into a TypeScript file. The package is intended to be used with TypeScript-based JavaScript frameworks, such as Angular. | |||
There was a problem hiding this comment.
This is the implementation. Add an executive summary that talks at an higher-level why we're doing this and the impact it has.
There was a problem hiding this comment.
the executive summary should answer the WHY and what problem we are solving.
…MENT.md - Add executive summary to TS-AppVersion documentation - Updated the documentation to include an executive summary, detailing the high-level benefits and impact of using TS-AppVersion for version management, such as enhanced traceability, streamlined deployment, improved communication, and effective compatibility management.
rngadam
suggested changes
Jan 24, 2024
| @@ -1,8 +1,112 @@ | |||
| # TS-AppVersion Readme | |||
|
|
|||
| TS-AppVersion is a package designed to extract version information from a project's package.json and Git (if configured) and save it into a TypeScript file. The package is intended to be used with TypeScript-based JavaScript frameworks, such as Angular. | |||
There was a problem hiding this comment.
the executive summary should answer the WHY and what problem we are solving.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#103