Skip to content
This repository was archived by the owner on Mar 10, 2023. It is now read-only.

Commit 42e6c03

Browse files
authored
Noviny/small docs updates (#179)
* system docs * system docs
1 parent 83a8a9d commit 42e6c03

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/mission-statement.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Brisk's Goal
2+
3+
> Build the best tool to document multi-package repositories
4+
5+
Brisk aims to meet this goal by understanding package information from multi-package repositories, as well as creating a consistent formula of docs, examples, changelogs, meta which they work to.
6+
7+
Brisk also draws clear lines and supports a distinction between system documentation and package documentation.

docs/release-process.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ We need to add safeguards to cover this out, so, when releasing also do:
3333
- [http://localhost:8080/packages/eslint-plugin-tangerine/](http://localhost:8080/packages/eslint-plugin-tangerine/)
3434

3535
* Declare a release is being organised, block merging to master
36-
* Have a release manager run `changeset bump`
36+
* Have a release manager run `yarn changeset bump`
3737
* PR the changes from this script back into master - get a review of changelogs, and packages will be published
38-
* Once merged, re-pull master, manually run `changeset release`, push tags
38+
* Once merged, re-pull master, manually run `yarn release`, push tags
3939
* Let everyone know it's safe to merge PRs again
40+
41+
yarn changeset release
42+
yarn release

0 commit comments

Comments
 (0)