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.

Sign up for GitHub

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

Jump to bottom

docs: rename foo/foo.md to foo/README.md in docs, update links #2258

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

docs: rename foo/foo.md to foo/README.md in docs, update links #2258

wants to merge 12 commits into from

Conversation

grepsuzette
Copy link
Contributor

Propose to rename it.

@grepsuzette grepsuzette requested review from a team and moul as code owners June 2, 2024 04:32
@grepsuzette
Copy link
Contributor Author

Not sure if good idea, but ChatGPT:

Renaming a foo/foo.md file to foo/README.md within a documentation tree can be a good practice in many cases.

The README.md file is commonly recognized as the primary documentation entry point in many projects. By renaming foo.md to README.md, you are following a standard convention that makes it easier for others to quickly understand the purpose of the file and the content it holds when they navigate through the documentation tree. This can improve the overall clarity and organization of your documentation.

@thehowl
Copy link
Member

thehowl commented Jun 3, 2024

this makes sense to me, seeing also as the urls on the website are not connected to the filename; but cc @leohhhn.

leohhhn
leohhhn approved these changes Jun 7, 2024
View reviewed changes
Copy link
Contributor

@leohhhn leohhhn left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes sense 👍

Could you do it for every index file for consistency? Each section has one.

@grepsuzette
Copy link
Contributor Author

This makes sense 👍

Could you do it for every index file for consistency? Each section has one.

Yep, I'll see if there are others!

moul
moul reviewed Jun 13, 2024
View reviewed changes
docs/assets/how-to-guides/creating-grc721/mynonfungibletoken-2.gno
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why removing this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file got removed in c67eff6 (notice it's not in https://github.com/gnolang/gno/tree/master/docs/assets/how-to-guides anymore) but it was still present in my PR.

I got conflicts such as files deleted or removed on master since this PR was opened and tried to solve them manually.

I was actually reading about rebase vs merge workflows because of that.

Will review #2125, thanks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I see. I think your PR is just unsynchronized with the master branch. You should update your branch.

Essentially, fix the Git-related issues, and this PR should no longer have the following:

CleanShot 2024-06-13 at 09 27 36

@moul
Copy link
Member

moul commented Jun 13, 2024

I noticed you removed several files. Was this intentional?

The PR title no longer matches the changes. Please update it.

I suggest reviewing #2125 as it's related and both are needed.

@moul moul mentioned this pull request Jun 13, 2024
Closed
7 tasks
moul
moul requested changes Jun 13, 2024
View reviewed changes
Copy link
Member

@moul moul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review #2125 first, as I believe this PR conflicts with its final purpose.

Once there is a clear action plan for those two pull requests, please let me know, and I'll review this PR again.

@grepsuzette grepsuzette changed the title docs: rename docs/reference/reference.md to README.md docs: rename :foo:/:foo:.md to :foo:/README.md, update links Jun 13, 2024
@grepsuzette grepsuzette changed the title docs: rename :foo:/:foo:.md to :foo:/README.md, update links docs: rename foo/foo.md to foo/README.md in docs, update links Jun 13, 2024
@Kouteki Kouteki added review/triage-pending PRs opened by external contributors that are waiting for the 1st review and removed review/triage-pending PRs opened by external contributors that are waiting for the 1st review labels Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@moul moul moul requested changes

@leohhhn leohhhn leohhhn approved these changes

@deelawn deelawn deelawn approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

@grepsuzette grepsuzette

Labels
None yet
Projects
💪 Bounties & Worx
Status: In Progress
🧙‍♂️gno.land core team
Status: In Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@grepsuzette @thehowl @moul @deelawn @leohhhn @Kouteki