Conversation
Fixes xmtp#2017 doc/xmtp-contracts-image.md was intentionally deleted in xmtp/smart-contracts#116 (containerized local dev environment docs removed), with no replacement page created - confirmed via the smart-contracts repo's current doc/ index. The issue asked whether this link should be replaced with another page from smart-contracts/doc/, removed, or left until new docs exist. I went with replacing it: pointed to smart-contracts' doc/README.md, which is the current, maintained documentation index and does exist. Also dropped the specific claim that the target 'contains the deterministic addresses where all the contracts are deployed' - I could not confirm that claim holds for any current page, so restating it here would just recreate an inaccurate docs. Happy to adjust to a different target page or wording if a maintainer has a better one in mind.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #2017
doc/xmtp-contracts-image.mdwas intentionally deleted in xmtp/smart-contracts#116 (containerized local dev environment docs removed), with no replacement page created — confirmed by checking the currentdoc/index in smart-contracts.The issue asked whether this link should be replaced with another page from
smart-contracts/doc/, removed, or left until new docs exist. I went with replacing it: pointed to smart-contracts'doc/README.md, which is the current, maintained documentation index and does exist.I also dropped the specific claim that the target "contains the deterministic addresses where all the contracts are deployed" — I could not confirm that claim holds for any current page in smart-contracts (the closest candidates,
doc/deployment.mdanddoc/proxies.md, describe the deployment procedure and mechanism, not a literal address reference), so restating it here would just recreate an inaccurate doc.Happy to adjust to a different target page or wording if a maintainer has a better one in mind — this was a judgment call on an intentionally open question.
Note
Fix broken link to smart-contracts docs in
doc/deploy.mdUpdates a broken link in doc/deploy.md that pointed to a deleted image doc, replacing it with a link to the smart-contracts documentation index.
Macroscope summarized 7240bbc.