Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Add documentation for Truffle Dashboard #1089

Merged
merged 13 commits into from
Feb 17, 2022
Merged

Add documentation for Truffle Dashboard #1089

merged 13 commits into from
Feb 17, 2022

Conversation

rkalis
Copy link
Contributor

@rkalis rkalis commented Dec 2, 2021

  • Add truffle dashboard to the commands reference
  • Add short guide called "Using the Truffle Dashboard" under "Getting Started"

@rkalis
Copy link
Contributor Author

rkalis commented Dec 2, 2021 •
edited
Loading

  • The screenshots are hard to read so we'll re-take them with a smaller window.
  • It's confusing that there is a top-level config field 'dashboard' as well as a network config 'dashboard'. We should make it clearer that that is intentional.
  • We need to add dashboard to the config reference.
  • Say that it's a bad idea to change networks in the middle of a migration.
  • Update after adding the builtin "dashboard" network.

rkalis added 3 commits January 6, 2022 15:49
@rkalis
Add documentation for Truffle Dashboard
a799dfe
@rkalis
Update Truffle Dashboard docs
5b777e7 
- Add 'dashboard' to config reference
- Make images more readable
- Add not about switching networks
- Update config examples
- Add note about builtin 'dashboard' network
@rkalis
Small updates to the dashboard docs
ab9ca8e
@rkalis rkalis force-pushed the truffle-dashboard branch from f1e5728 to ab9ca8e Compare January 6, 2022 14:49
fainashalts
fainashalts reviewed Feb 17, 2022
View reviewed changes
Copy link
Contributor

@fainashalts fainashalts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just some minor grammatical suggestions.

src/docs/truffle/getting-started/using-the-truffle-dashboard.md Outdated Show resolved Hide resolved
src/docs/truffle/getting-started/using-the-truffle-dashboard.md Outdated Show resolved Hide resolved
src/docs/truffle/getting-started/using-the-truffle-dashboard.md Outdated Show resolved Hide resolved
src/docs/truffle/getting-started/using-the-truffle-dashboard.md Outdated Show resolved Hide resolved
src/docs/truffle/getting-started/using-the-truffle-dashboard.md Outdated Show resolved Hide resolved
src/docs/truffle/getting-started/using-the-truffle-dashboard.md Outdated Show resolved Hide resolved
src/docs/truffle/reference/configuration.md Outdated Show resolved Hide resolved
its-everdred
its-everdred approved these changes Feb 17, 2022
View reviewed changes
Copy link
Contributor

@its-everdred its-everdred left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions, but looks great! Giving a preemptive 👍 after those are resolved. 🎉

fainashalts and others added 7 commits February 17, 2022 09:19
fainashalts
fainashalts approved these changes Feb 17, 2022
View reviewed changes
Copy link
Contributor

@fainashalts fainashalts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kevinbluer kevinbluer merged commit 9c3b21a into main Feb 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gnidan gnidan gnidan left review comments

@its-everdred its-everdred its-everdred approved these changes

@fainashalts fainashalts fainashalts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rkalis @gnidan @its-everdred @fainashalts @kevinbluer