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

Chainlink local #2012

Merged
merged 49 commits into from
Aug 14, 2024
Merged

Chainlink local #2012

merged 49 commits into from
Aug 14, 2024

Conversation

aelmanaa
Copy link
Collaborator

@aelmanaa aelmanaa commented Jul 29, 2024

Copy link

vercel bot commented Jul 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Aug 14, 2024 10:41am

@aelmanaa aelmanaa marked this pull request as draft July 29, 2024 15:10
Copy link
Collaborator

@thedriftofwords thedriftofwords left a comment

Choose a reason for hiding this comment

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

FYI: Adding my first round of editorial review as comments to share my thought process; I'll follow up by addressing most of my own comments directly as commits, leaving open those that I have a question about.

src/content/chainlink-local/learn/architecture.mdx Outdated Show resolved Hide resolved
src/content/chainlink-local/learn/architecture.mdx Outdated Show resolved Hide resolved
src/content/chainlink-local/index.mdx Outdated Show resolved Hide resolved
date: Last Modified
title: "Test CCIP Locally"
---

Copy link
Collaborator

@thedriftofwords thedriftofwords Aug 11, 2024

Choose a reason for hiding this comment

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

General editing checks

  • Sentence case on titles and section titles
  • Decide on the best definition for CL Local and use it consistently in page overviews and conceptual pages - is it a library? a set of installable packages? a set of tools and libraries?
  • Replace diagram drafts with updated ones from design team when available

Copy link
Collaborator

Choose a reason for hiding this comment

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

Screenshot 2024-08-11 at 2 22 31 PM

This callout seems a little redundant on the guides pages because the same installation instruction is included in the Prerequisites section - but it might be OK to leave on the index pages?

@thedriftofwords
Copy link
Collaborator

thedriftofwords commented Aug 14, 2024

Some of my own comments above left open intentionally; these items need discussion and a follow-up PR, but aren't blockers to initially publishing these docs.

@aelmanaa aelmanaa merged commit f0dd559 into main Aug 14, 2024
4 checks passed
@aelmanaa aelmanaa deleted the ccip-local branch August 14, 2024 14:23
thedriftofwords added a commit to thedriftofwords/documentation that referenced this pull request Aug 14, 2024
* chainlink-local api ref

* chainlink-local api ref

* First edit pass: intro page and minor formatting stuff in API pages

* Baseline architecture page + main page minor fix

* Edit 1 on architecture page

* Revisions round 2

* Link fix

* Baseline local simulator guide

* First edit pass on local simulator guide

* Local simulator guide: edit round 2 plus images

* Add to sidebar; formatting fix

* Baseline simulator fork content plus attempted boilerplate to use PageTabs

* chainlink local

* add index

* add index

* fix formatting

* fix formatting

* fix formatting

* fix links

* fix links

* fix links

* hardhat guides

* index

* fix links

* install instructions

* remix

* remix

* remix

* remix

* remix

* remix

* contributing

* video

* architecture

* nit

* refer in CCIP

* nit

* edit: architecture

* edit: ccip guides index pages

* edit: ccip hardhat guides

* edit: sidebar and ccip remix guide

* edit: data feeds api pages, main intro page

* edit: ccip foundry guides

* edit: miscellaneous nits

* nit

* pin @chainlink/local version

---------

Co-authored-by: Crystal Gomes <thedriftofwords@users.noreply.github.com>
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