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

Update index.rst for Contribute topic #74

Merged
merged 2 commits into from
Mar 23, 2023
Merged

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Mar 22, 2023

In the "Build documentation" section, do we still need the information about where the doc for the latest stable versus latest development versions are located? It seems that it's more important that they know how to use the menu option for toggling between the doc for different versions.

In the "Build documentation" section, do we still need the information about where the doc for the latest stable versus latest development versions are located? It seems that it's more important that they know how to use the menu option for toggling between the doc for different versions.
@PipKat PipKat requested a review from clatapie March 22, 2023 14:41
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 22, 2023
@clatapie
Copy link
Collaborator

You're right @PipKat. This would be clearer to mention the tool for switching from one version to another.

Add missing back tick to email address edit
@PipKat PipKat changed the title Update index.rst Update index.rst for Contribute topic Mar 22, 2023
@PipKat
Copy link
Member Author

PipKat commented Mar 22, 2023

@clatapie What do you think of replacing the doc location stuff with this:

In the upper right corner of the documentation's title bar, there is an option
for switching from viewing the documentation for the latest stable release
to viewing the documentation for the development version or previously
released versions.

@clatapie
Copy link
Collaborator

This works for me. I'll ping @RobPasMue for visibility to ensure that there is no general documentation on this subject that I might have missed.

@clatapie What do you think of replacing the doc location stuff with this:

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

@PipKat
Copy link
Member Author

PipKat commented Mar 22, 2023

@RobPasMue If you like this suggestion, I can find other libraries with "View Documentation" sections and make the same changes after returning from the ChatGPT hackathon.

@RobPasMue
Copy link
Member

I totally agree. We should change that. Thanks @PipKat! Please go ahead and put that task in your pipeline post-hackathon. See you in a few days!! 😄

@RobPasMue RobPasMue merged commit cf41a87 into main Mar 23, 2023
@RobPasMue RobPasMue deleted the Update-support-email-address branch March 23, 2023 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants