Documentation Updates #284
Merged
Conversation
This file contains hidden or 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
haoliu-amp
suggested changes
Aug 21, 2020
src/notes.md
Outdated
| - Use Amplitude Instrumentation Explorer to help development | ||
| - "Instrumentation" involves matters related to logging user actions (i.e. events) | ||
|
|
||
| # Concerns |
Contributor
There was a problem hiding this comment.
This one sounds like more useful to yourself. Only put notes which are useful for others to understand this SDK better.
Contributor
There was a problem hiding this comment.
I guess we should move all this notes to a contributing.md file as a setup guide.
src/notes.md
Outdated
| # Misc | ||
| - Readme.io used for documentation | ||
|
|
||
| # Ideas |
Contributor
There was a problem hiding this comment.
This should be also private to yourself.
src/notes.md
Outdated
| - E2E browser tests with sauce labs | ||
| - merge with node? | ||
|
|
||
| Question |
Contributor
There was a problem hiding this comment.
Can convert these to concrete Q&As
haoliu-amp
approved these changes
Aug 21, 2020
src/notes.md
Outdated
| @@ -0,0 +1,25 @@ | |||
| # Intro | |||
Contributor
There was a problem hiding this comment.
Again, do you think renaming this file to CONTRIBUTING.md would be a better option to make this to be a setup guide?
Contributor
Author
There was a problem hiding this comment.
I moved src/notes.md to CONTRIBUTING.md and added a reference to it in the README.md quick start section
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.
Notes I jotted down when diving into the JS SDK codebase. Consists of two parts
notes.mdthat contain bullet points about architecture, useful tips, etc.Maybe we should make a CONTRIBUTING.md, Github wiki, or space in the SDK documentation to help introduce new visitors to the repo?