Skip to content
This repository was archived by the owner on May 22, 2025. It is now read-only.

Docs: Add more information about Connectors#95

Merged
0xGabi merged 5 commits intomasterfrom
connectors-docs
Jul 2, 2020
Merged

Docs: Add more information about Connectors#95
0xGabi merged 5 commits intomasterfrom
connectors-docs

Conversation

@0xGabi
Copy link
Copy Markdown
Contributor

@0xGabi 0xGabi commented Jul 1, 2020

No description provided.

const { votes } = results.data
```

{% hint style="warning" %}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Note this is the syntax that GitBook use to create hints.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 1, 2020

Codecov Report

Merging #95 into master will decrease coverage by 1.84%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #95      +/-   ##
==========================================
- Coverage   28.99%   27.15%   -1.85%     
==========================================
  Files          53       55       +2     
  Lines         838      939     +101     
  Branches      137      157      +20     
==========================================
+ Hits          243      255      +12     
- Misses        595      684      +89     
Flag Coverage Δ
#unittests 27.15% <ø> (-1.85%) ⬇️
Impacted Files Coverage Δ
packages/connect-thegraph/src/parsers/apps.ts 92.30% <0.00%> (-0.29%) ⬇️
packages/connect-core/src/entities/App.ts 0.00% <0.00%> (ø)
packages/connect-core/src/entities/Repo.ts 0.00% <0.00%> (ø)
packages/connect-core/src/entities/Organization.ts 1.23% <0.00%> (+1.23%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c2c677e...16646b0. Read the comment docs.

Copy link
Copy Markdown
Contributor

@Evalir Evalir left a comment

Choose a reason for hiding this comment

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

Adding some suggestions over the docs! It's looking so clear already 🔥

Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/connectors/tokens-app.md Outdated
Comment thread docs/connectors/tokens-app.md Outdated
Comment thread docs/connectors/voting-app.md Outdated
Comment thread docs/connectors/voting-app.md Outdated
Comment thread docs/connectors/voting-app.md Outdated
Co-authored-by: Enrique Ortiz <enrique@aragon.one>
@0xGabi
Copy link
Copy Markdown
Contributor Author

0xGabi commented Jul 1, 2020

@Evalir thanks a lot for the review 🙏

Copy link
Copy Markdown
Contributor

@bpierre bpierre left a comment

Choose a reason for hiding this comment

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

LGTM apart from a few comments, mostly nitpicking! ✂️

Comment thread docs/SUMMARY.md Outdated
Comment thread docs/advanced/low-level-queries.md Outdated
const wrapper = new GraphQLWrapper(VOTING_SUBGRAPH_URL)

// Fetch the data performing the custom query
const results = await wrapper.performQuery(gql(QUERY))
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don’t think gql(QUERY) would work? We should probably do this instead:

const QUERY = gql`
  # …
`

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I like more the option you propose. Regardless the other way also works because I check on 1Hive's honey-pot and it's writing like gql(QUERY)

Copy link
Copy Markdown
Contributor

@bpierre bpierre Jul 2, 2020

Choose a reason for hiding this comment

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

Interesting, I imagine gql checks if it receives an array of strings or a string, and adapt its behavior to work in both cases 🤔

Edit: Yes 😄 https://github.com/apollographql/graphql-tag/blob/9b719a77530b81acc48be238e2dee3cf28e65beb/src/index.js#L158

Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/advanced/low-level-queries.md Outdated
Comment thread docs/connectors/organizations.md Outdated
Comment thread docs/guides/getting-started.md
Comment thread docs/connectors/voting-app.md Outdated
Comment thread docs/connectors/voting-app.md Outdated
Comment thread docs/connectors/tokens-app.md Outdated
@@ -0,0 +1,84 @@
# Answering questions with custom queries
Copy link
Copy Markdown
Contributor

@bpierre bpierre Jul 1, 2020

Choose a reason for hiding this comment

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

Just as a note, GitBook doesn’t like file names that don’t match the title (that’s why we have e.g. transactionrequest.md rather than transaction-request.md), but I don’t think it matters since we protected the master branch.

0xGabi and others added 2 commits July 1, 2020 23:52
Co-authored-by: Pierre Bertet <hello@pierre.world>
@0xGabi 0xGabi merged commit b37f234 into master Jul 2, 2020
@0xGabi 0xGabi deleted the connectors-docs branch July 2, 2020 02:54
@bpierre bpierre mentioned this pull request Jul 3, 2020
2 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants