-
Notifications
You must be signed in to change notification settings - Fork 884
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
KarhouTam
wants to merge
11
commits into
adap:main
Choose a base branch
from
KarhouTam:improve-readme-url-orientation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
Btw, seems |
KarhouTam
requested review from
jafermarq,
tanertopal and
danieljanes
as code owners
October 4, 2024 04:13
Thank @KarhouTam ! @tanertopal what do you think about these changes to the URL? |
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
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.
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 localflower
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/
orhttps://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