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

docs(framework) Improve URLs orientation for better user experience #4284

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

KarhouTam
Copy link
Contributor

@KarhouTam KarhouTam commented Oct 3, 2024

Issue

Description

When users click on URLs in the READMEs that link to files or directories within the flower project, a webpage will open displaying the content found in their local flower project directory.

So maybe a better URL should link to the file/directory at the local rather than on https://github.com/adap/flower/tree/main/.

Proposal

Explanation

Change all URLs in READMEs that have the prefix https://github.com/adap/flower/tree/main/ or https://github.com/adap/flower/blob/main/ to relative paths, e.g.,

A URL in flower/examples/advanced-pytorch/README.md:
https://github.com/adap/flower/tree/main/examples/quickstart-pytorch -> ../quickstart-pytorch/README.md

Besides, I added README.md at the end of some URLs for better orientation.

Modified URLs will function the same as before when clicked on the website, and will be more logical locally.

Demonstration

before.mp4
after.mp4

@KarhouTam
Copy link
Contributor Author

"The code in this directory is fairly similar to that presented in [simulation-pytorch example] (../simulation-pytorch)"

Btw, seems simulation-pytorch is deprecated.

@KarhouTam KarhouTam marked this pull request as ready for review October 4, 2024 04:13
@jafermarq
Copy link
Contributor

Thank @KarhouTam ! @tanertopal what do you think about these changes to the URL?

@KarhouTam
Copy link
Contributor Author

Hi, @tanertopal . What do you think about these changes? I think they are not harmful at all and make flower developers maintein the URLs easier.

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