Skip to content
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

Merged
merged 4 commits into from
Jan 12, 2024
Merged

Minor doc fixes #882

merged 4 commits into from
Jan 12, 2024

Conversation

minkimcello
Copy link
Collaborator

@minkimcello minkimcello commented Jan 9, 2024

Motivation

I was reading through the docs and noticed some typos and formatting inconsistencies.

Approach

  • Fixed typos
  • Added missing import in an example
  • Comments in shell start with #
  • Set OSS link to effection in the header to / and now displays v3 instead of v2
  • Capitalized H in GitHub for the header link
  • There were two places where an operation was written as function *foo instead of function* foo. although it works either way, it was written as function* foo everywhere else so I fixed the two for consistency
  • An example for streams was missing channel. for sending messages

Copy link
Member

@cowboyd cowboyd left a 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?

url: "/V2/",
version: "v2",
url: "/",
version: "v3",
Copy link
Member

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?

Copy link
Collaborator Author

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:

Screenshot 2024-01-09 at 10 17 10 AM

But for now I'll just revert it back to V2.

@minkimcello
Copy link
Collaborator Author

Someone's going to have to merge this for me.

@cowboyd
Copy link
Member

cowboyd commented Jan 10, 2024

@minkimcello Can you set up commit signing?

@minkimcello
Copy link
Collaborator Author

@minkimcello Can you set up commit signing?

🫡

@cowboyd
Copy link
Member

cowboyd commented Jan 12, 2024

@minkimcello I went ahead and rebased it for you.

@minkimcello
Copy link
Collaborator Author

@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.

@cowboyd cowboyd merged commit e990bc0 into thefrontside:v3 Jan 12, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants