Skip to content

Commit

Permalink
Merge pull request #100 from 0xPolygonID/document-query-builder-v2
Browse files Browse the repository at this point in the history
Document query builder v2
  • Loading branch information
elias-garcia authored Feb 7, 2024
2 parents a4c0184 + 4ac8328 commit 93d2806
Show file tree
Hide file tree
Showing 11 changed files with 253 additions and 120 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
# Except these files
!docs
!src
!docusaurus.config.js
198 changes: 174 additions & 24 deletions docs/verifier/query-builder.md

Large diffs are not rendered by default.

174 changes: 78 additions & 96 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const math = require('remark-math');
const katex = require('rehype-katex');
const math = require("remark-math");
const katex = require("rehype-katex");

module.exports = {
title: "Polygon ID Documentation",
Expand All @@ -14,58 +14,62 @@ module.exports = {
description: "Build your next blockchain dApp using Polygon ID.",
},
i18n: {
defaultLocale: 'en',
locales: ['en'],
path: 'i18n',
defaultLocale: "en",
locales: ["en"],
path: "i18n",
localeConfigs: {
en: {
label: 'English',
direction: 'ltr',
htmlLang: 'en-US',
calendar: 'gregory',
path: 'en',
label: "English",
direction: "ltr",
htmlLang: "en-US",
calendar: "gregory",
path: "en",
},
},
},

onBrokenLinks: 'log',
onBrokenLinks: "log",
themeConfig: {
announcementBar: {
id: 'learn_more',
id: "learn_more",
content:
'New Release: Credentials Marketplace, On-chain Issuer and Issuer Node Improvements <a class="announcement-link" target="_blank" rel="noopener noreferrer" href="/docs/release-notes/r5"> Learn more</a> <a class="announcement-link" target="_blank" rel="noopener noreferrer" href="https://polygon.technology/blog/polygon-id-release-5-boosting-credential-liquidity?utm_source=twitter&utm_medium=social&utm_content=id-r5-blog"> Check our blog</a>',
backgroundColor: '#20232a',
textColor: '#fff',
'New Release: Credentials Marketplace, On-chain Issuer and Issuer Node Improvements <a class="announcement-link" target="_blank" rel="noopener noreferrer" href="/docs/release-notes/r5"> Learn more</a> <a class="announcement-link" target="_blank" rel="noopener noreferrer" href="https://polygon.technology/blog/polygon-id-release-5-boosting-credential-liquidity?utm_source=twitter&utm_medium=social&utm_content=id-r5-blog"> Check our blog</a>',
backgroundColor: "#20232a",
textColor: "#fff",
isCloseable: false,
},
metadata: [{name: 'description', content: 'Welcome to Polygon ID Documentation, the official documentation for Polygon ID.'}],
metadata: [
{
name: "description",
content: "Welcome to Polygon ID Documentation, the official documentation for Polygon ID.",
},
],
colorMode: {
defaultMode: 'dark',
defaultMode: "dark",
disableSwitch: true,
respectPrefersColorScheme: false,
},

footer: {
style: 'dark',
links: [
],
style: "dark",
links: [],
},

image: 'img/thumbnail.jpg',
image: "img/thumbnail.jpg",
prism: {
theme: require("prism-react-renderer/themes/github"),
darkTheme: require("prism-react-renderer/themes/dracula"),
defaultLanguage: "javascript",
additionalLanguages: ['solidity']
additionalLanguages: ["solidity"],
},
algolia: {
// need to update this
indexName: "devs-polygonid",
appId: 'VHJ21ILMOQ',
appId: "VHJ21ILMOQ",
apiKey: "2281aa8fc382facc33ebfbb1e745e442",
contextualSearch: true,
algoliaOptions: {
attributesToSnippet: ['content:20'],
attributesToSnippet: ["content:20"],
},
},
navbar: {
Expand All @@ -74,116 +78,95 @@ module.exports = {
alt: "Polygon logo",
src: "img/polygon-id.svg",
srcDark: "img/polygon-id.svg",
href: '/',
href: "/",
target: "_self",
},
},
items: [
{
position: 'left',
label: 'Build',
position: "left",
label: "Build",
items: [
{
href: '/docs/issuer/issuer-node-ui',
label: 'Issuer API+UI',
rel: null,
href: "/docs/issuer/issuer-node-ui",
label: "Issuer API+UI",
},
{
href: '/docs/verifier/verifier-overview/',
label: 'Verifier SDK',
rel: null,
href: "/docs/verifier/verifier-overview/",
label: "Verifier SDK",
},
{
href: '/docs/wallet/wallet-overview/',
label: 'Wallet SDK',
rel: null,
href: "/docs/wallet/wallet-overview/",
label: "Wallet SDK",
},
{
href: '/docs/js-sdk/js-sdk-overview/',
label: 'JS-SDK',
rel: null,
}
]
href: "/docs/js-sdk/js-sdk-overview/",
label: "JS-SDK",
},
],
},
{
position: 'left',
label: 'Tools',
position: "left",
label: "Tools",
items: [
{
href: 'https://schema-builder.polygonid.me/',
label: 'Schema Explorer',
target: '_blank',
rel: null,
href: "https://schema-builder.polygonid.me/",
label: "Schema Explorer",
},
{
href: 'https://schema-builder.polygonid.me/builder',
label: 'Schema Builder',
target: '_blank',
rel: null,
href: "https://schema-builder.polygonid.me/builder",
label: "Schema Builder",
},
{
href: 'https://schema-builder.polygonid.me/query-builder',
label: 'Query Builder',
target: '_blank',
rel: null,
href: "https://schema-builder.polygonid.me/query-builder",
label: "Query Builder",
},
{
href: '/',
label: 'JWZ (coming soon)',
target: '_blank',
className: "disabled",
href: "https://jwz.polygonid.me",
label: "JWZ Validator",
},
]
],
},
{
position: 'left',
label: 'Learn',
position: "left",
label: "Learn",
items: [
{
href: 'https://www.youtube.com/playlist?list=PLRD3rkREa7mLLJ6jfUTygXV1iK_AvsDdw',
label: 'Fundamentals',
target: '_blank',
rel: null,
href: "https://www.youtube.com/playlist?list=PLRD3rkREa7mLLJ6jfUTygXV1iK_AvsDdw",
label: "Fundamentals",
},
{
href: 'https://www.youtube.com/playlist?list=PLRD3rkREa7mLjDB1qL4KkCtob6kPJIvhS',
label: 'Architecture',
target: '_blank',
rel: null,
href: "https://www.youtube.com/playlist?list=PLRD3rkREa7mLjDB1qL4KkCtob6kPJIvhS",
label: "Architecture",
},
{
href: 'https://www.youtube.com/playlist?list=PLRD3rkREa7mIgx_RHZdin74vEb2A1Evek',
label: 'Inside Polygon ID',
target: '_blank'
href: "https://www.youtube.com/playlist?list=PLRD3rkREa7mIgx_RHZdin74vEb2A1Evek",
label: "Inside Polygon ID",
},
]

],
},
{
position: 'left',
label: 'Releases',
href: '/docs/releases'
position: "left",
label: "Releases",
href: "/docs/releases",
},
{
position: 'left',
label: 'Support',
href: 'https://support.polygon.technology/support/solutions/82000473421',
target: '_blank',
position: "left",
label: "Support",
href: "https://support.polygon.technology/support/solutions/82000473421",
},
{
position: 'left',
label: 'Protocol',
position: "left",
label: "Protocol",
items: [
{
href: 'https://docs.iden3.io/',
label: 'Iden3 General Docs',
target: '_blank',
href: "https://docs.iden3.io/",
label: "Iden3 General Docs",
},
{
href: 'https://iden3-communication.io/',
label: 'Iden3comm',
target: '_blank',
href: "https://iden3-communication.io/",
label: "Iden3comm",
},
]
],
},
{
href: "https://github.com/0xPolygonID",
Expand All @@ -208,8 +191,7 @@ module.exports = {
{
href: "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css",
type: "text/css",
integrity:
"sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc",
integrity: "sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc",
crossorigin: "anonymous",
},
],
Expand All @@ -218,14 +200,14 @@ module.exports = {
"@docusaurus/preset-classic",
{
docs: {
routeBasePath: '/docs',
routeBasePath: "/docs",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/0xPolygonID/id-docs/tree/main",
path: "docs",
showLastUpdateAuthor: true,
showLastUpdateTime: true,
remarkPlugins: [math],
rehypePlugins: [[katex, {strict: false, throwOnError: true,globalGroup: true}]],
rehypePlugins: [[katex, { strict: false, throwOnError: true, globalGroup: true }]],
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
Expand Down
Binary file added static/img/query-builder-attribute-field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/query-builder-filled.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed static/img/query-builder-outcome.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/query-builder-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/query-builder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 93d2806

Please sign in to comment.