-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor doc fixes #882
Minor doc fixes #882
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good, although I do have one question about the project selector?
www/components/project-select.tsx
Outdated
url: "/V2/", | ||
version: "v2", | ||
url: "/", | ||
version: "v3", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was so that you could switch from v3 to v2. There's no need to switch back to v3 if you're on v3 is there?
Is it confusing? If so, maybe we take it out of the switcher altogether?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohh I see. It does look like it was forgotten to be updated. On interactors and bigtest, they also have links that routes back to its own page so I don't think it's that weird to have effection v3 in the oss dropdown.
If there's a user that lands on v3 docs and is looking for v2, I'm not sure if their instinct would be to navigate to the OSS dropdown to find the v2 docs. For users to be able to find V2, we could introduce a versions dropdown:
But for now I'll just revert it back to V2
.
b21e857
to
902efdb
Compare
Someone's going to have to merge this for me. |
@minkimcello Can you set up commit signing? |
f5c452a
to
9a0e1ab
Compare
🫡 |
9a0e1ab
to
2edc5ae
Compare
@minkimcello I went ahead and rebased it for you. |
Thank you. I don't have write access so if the PR looks good you can go ahead and merge it for me. |
Motivation
I was reading through the docs and noticed some typos and formatting inconsistencies.
Approach
#
Set OSS link to effection in the header to/
and now displaysv3
instead ofv2
function *foo
instead offunction* foo
. although it works either way, it was written asfunction* foo
everywhere else so I fixed the two for consistencychannel.
for sending messages