chore: fixes the link to namespace implementation #3653

staheri14 · 2024-07-02T23:40:02Z

This link was previously fixed, but apparently, the file for namespace implementation has been moved again (the directory name has changed). Hence, here is the new fix.

github-actions · 2024-07-02T23:40:24Z

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-3653/
on branch `gh-pages` at 2024-07-03 20:55 UTC

coderabbitai · 2024-07-02T23:40:36Z

Walkthrough

The changes involve updating URL references in the namespace.md markdown file of the project. Specifically, the update corrects the path to the namespace implementation due to recent refactoring in the go-square repository. This ensures that documentation remains accurate and functional without causing errors in markdown linting processes.

Changes

Files	Change Summary
`specs/src/specs/namespace.md`	Updated URL references from `shares/namespace.go` to `share/namespace.go` to reflect changes in the `go-square` repository.

Possibly related issues

Fixing broken link to the namespace implementation #3639: Fixes the broken link to the namespace implementation as mentioned in the issue, ensuring markdown linter does not error out.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e25948f and 55f013d.

Files selected for processing (1)

specs/src/specs/namespace.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

specs/src/specs/namespace.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

staheri14 · 2024-07-02T23:41:20Z

specs/src/specs/namespace.md

@@ -94,7 +94,7 @@ Among the potential consequences is the _Woods Attack_, as elaborated in this fo

 ## Implementation

-See [go-square/namespace](https://github.com/celestiaorg/go-square/blob/main/shares/namespace.go).
+See [go-square/namespace](https://github.com/celestiaorg/go-square/blob/main/share/namespace.go).


I intentionally didn't use a permalink to ensure that we always track its most recent location and receive errors in CIs if it changes.

[no change needed] it's a bit confusing currently b/c we don't have versioned specs so it's not immediately clear if these specs should describe the celestia-app v1.x behavior or v2.x behavior. A permalink to the previous implementation(s) is correct for v1.x and v2.x. A link to the new location (this PR) isn't actually correct yet because celestia-app doesn't use main of go-square. There is no official release of go-square with those breaking changes so if we want to be 100% accurate, we probably shouldn't point to them from these specs yet. Not super opinionated about it and your change future-proofs the specs a bit so seems fine to me.

Good point. Considering this new information, I have slightly revised the text and provided two links: one to the version of the code that matches the current specifications, and one pointing to the most recent version of the code. Please see f45bfbe

rootulp · 2024-07-03T14:16:05Z

specs/src/specs/namespace.md

@@ -94,7 +94,7 @@ Among the potential consequences is the _Woods Attack_, as elaborated in this fo

 ## Implementation

-See [go-square/namespace](https://github.com/celestiaorg/go-square/blob/main/shares/namespace.go).
+See [go-square/namespace](https://github.com/celestiaorg/go-square/blob/main/share/namespace.go).


[no change needed] it's a bit confusing currently b/c we don't have versioned specs so it's not immediately clear if these specs should describe the celestia-app v1.x behavior or v2.x behavior. A permalink to the previous implementation(s) is correct for v1.x and v2.x. A link to the new location (this PR) isn't actually correct yet because celestia-app doesn't use main of go-square. There is no official release of go-square with those breaking changes so if we want to be 100% accurate, we probably shouldn't point to them from these specs yet. Not super opinionated about it and your change future-proofs the specs a bit so seems fine to me.

staheri14 · 2024-07-03T20:49:50Z

specs/src/specs/namespace.md

@@ -94,7 +94,8 @@ Among the potential consequences is the _Woods Attack_, as elaborated in this fo

 ## Implementation

-See [go-square/namespace](https://github.com/celestiaorg/go-square/blob/main/shares/namespace.go).
+See the [namespace implementation in go-square](https://github.com/celestiaorg/go-square/blob/be3c2801e902a0f90f694c062b9c4e6a7e01154e/namespace/namespace.go). 


The permalink provided here is based on this file from v1.1.0 of go-square, which is the version of go-square currently used in the main and v2.x branches of celestia-app. cc: @rootulp Please let me know if the version linked here does or does not align with the spec.

fixes a link

e25948f

staheri14 marked this pull request as ready for review July 2, 2024 23:40

staheri14 requested review from liamsi and a team as code owners July 2, 2024 23:40

staheri14 requested review from ramin and ninabarbakadze and removed request for a team July 2, 2024 23:40

staheri14 requested review from evan-forbes and removed request for liamsi and ramin July 2, 2024 23:40

staheri14 self-assigned this Jul 2, 2024

staheri14 commented Jul 2, 2024

View reviewed changes

staheri14 added the chore optional label for items that follow the `chore` conventional commit label Jul 2, 2024

staheri14 mentioned this pull request Jul 2, 2024

test: adding big block tests to the main branch #3612

Merged

rootulp previously approved these changes Jul 3, 2024

View reviewed changes

provides another link to the old version

f45bfbe

staheri14 dismissed rootulp’s stale review via f45bfbe July 3, 2024 20:45

celestia-bot requested a review from a team July 3, 2024 20:45

staheri14 requested a review from rootulp July 3, 2024 20:47

staheri14 commented Jul 3, 2024

View reviewed changes

staheri14 added 2 commits July 3, 2024 13:53

Merge branch 'main' into sanaz/fix-ns-link

25c6e99

fixes. minor linter problem

7c7c668

evan-forbes approved these changes Jul 4, 2024

View reviewed changes

rootulp approved these changes Jul 4, 2024

View reviewed changes

Merge branch 'main' into sanaz/fix-ns-link

55f013d

celestia-bot requested review from a team and cmwaters and removed request for a team July 5, 2024 18:23

staheri14 enabled auto-merge (squash) July 5, 2024 18:29

staheri14 merged commit 3fafc00 into main Jul 5, 2024
34 of 35 checks passed

staheri14 deleted the sanaz/fix-ns-link branch July 5, 2024 18:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: fixes the link to namespace implementation #3653

chore: fixes the link to namespace implementation #3653

staheri14 commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading

coderabbitai bot commented Jul 2, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

staheri14 Jul 2, 2024

rootulp Jul 3, 2024

staheri14 Jul 3, 2024 •

edited

Loading

rootulp Jul 3, 2024

staheri14 Jul 3, 2024 •

edited

Loading

chore: fixes the link to namespace implementation #3653

chore: fixes the link to namespace implementation #3653

Conversation

staheri14 commented Jul 2, 2024 • edited Loading

github-actions bot commented Jul 2, 2024 • edited Loading

coderabbitai bot commented Jul 2, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

staheri14 Jul 2, 2024

Choose a reason for hiding this comment

rootulp Jul 3, 2024

Choose a reason for hiding this comment

staheri14 Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

rootulp Jul 3, 2024

Choose a reason for hiding this comment

staheri14 Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

staheri14 commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading

coderabbitai bot commented Jul 2, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

staheri14 Jul 3, 2024 •

edited

Loading

staheri14 Jul 3, 2024 •

edited

Loading