The docs from the-guild-org

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

chore(deps): update nextra to v3.0.0-alpha.23 (nextra, nextra-theme-docs)
fix(deps): update dependency clsx to v2.1.1
chore(deps): update dependency monaco-editor to v0.48.0
fix(deps): update nextjs monorepo to v13.5.6 (@next/bundle-analyzer, next)
fix(deps): update nextjs monorepo to v14 (major) (@next/bundle-analyzer, next)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

fix(deps): update dependency graphql-language-service to v5

Detected dependencies

github-actions

.github/workflows/ci.yml

actions/checkout v4

pnpm/action-setup v3.0.0

actions/setup-node v4

.github/workflows/cloudflare-workers.yaml

actions/checkout v4

.github/workflows/pr.yml

.github/workflows/release.yml

nodenv

.node-version

node 20

npm

package.json

@changesets/changelog-github 0.5.0

@changesets/cli 2.27.1

@rollup/plugin-alias 5.1.0

@storybook/addon-postcss 2.0.0

@storybook/global ^5.0.0

@storybook/mdx2-csf 1.1.0

@svgr/webpack 8.1.0

@theguild/eslint-config 0.11.6

@theguild/prettier-config 2.0.6

@theguild/tailwind-config 0.4.1

@types/jest-image-snapshot 6.4.0

@types/react 18.2.76

@types/react-paginate 7.1.4

@types/webpack 5.28.5

concurrently 8.2.2

css-loader 7.1.1

eslint 8.57.0

eslint-plugin-storybook 0.8.0

eslint-plugin-tailwindcss 3.15.1

husky 9.0.11

jest-image-snapshot 6.4.0

lint-staged 15.2.2

next-themes 0.3.0

postcss 8.4.38

postcss-loader 8.1.1

prettier 3.2.5

prettier-plugin-tailwindcss 0.5.14

pretty-quick 4.0.0

react 18.2.0

react-dom 18.2.0

storybook-addon-next 1.8.0

storybook-addon-swc 1.2.0

storybook-dark-mode 4.0.1

style-loader 4.0.0

tailwindcss 3.4.3

tsconfig-paths-webpack-plugin 4.1.0

tsup 8.0.2

tsx 4.7.2

turbo 1.13.2

typescript 5.4.5

vitest 0.34.6

node >=20

pnpm >=8.15

pnpm 8.15.7

hast-util-to-estree ^2.3.3

packages/components/package.json

@giscus/react 3.0.0

@next/bundle-analyzer 13.4.2

clsx 2.1.0

fuzzy 0.1.3

next-videos 1.5.0

nextra 3.0.0-alpha.22

nextra-theme-docs 3.0.0-alpha.22

react-paginate 8.2.0

react-player 2.16.0

remark-mdx-disable-explicit-jsx 0.1.0

semver ^7.3.8

@svgr/babel-plugin-remove-jsx-attribute ^8.0.0

@types/dedent 0.7.2

@types/react-dom 18.2.25

@types/semver 7.5.8

dedent 1.5.3

esbuild-plugin-svgr ^2.1.0

graphql 16.8.1

next 13.4.2

react 18.2.0

react-dom 18.2.0

unified ^11.0.3

next ^13 || ^14

react ^18.2.0

react-dom ^18.2.0

packages/editor/package.json

graphql-language-service 3.2.5

@monaco-editor/react 4.6.0

graphql 16.8.1

monaco-editor 0.47.0

@monaco-editor/react ^4

monaco-editor ^0.40.0 || ^0.41.0 || ^0.43.0 || ^0.44.0 || ^0.47.0

react ^18.2.0

react-dom ^18.2.0

packages/og-image/package.json

@resvg/resvg-wasm 2.6.2

react 18.2.0

satori 0.10.13

yoga-wasm-web 0.3.3

@cloudflare/workers-types 4.20240405.0

@types/react 18.2.76

typescript 5.4.5

wrangler 3.50.0

packages/remark-mermaid/package.json

mermaid ^10.2.2

unist-util-visit ^5.0.0

@types/mdast 4.0.3

react 18.2.0

unified 11.0.4

react ^18.2.0

packages/remark-npm2yarn/package.json

npm-to-yarn ^2.1.0

unist-util-visit ^5.0.0

@types/mdast 4.0.3

nextra 3.0.0-alpha.22

unified 11.0.4

website/package.json

next 13.4.2

next-mdx-remote 4.4.1

react 18.2.0

react-dom 18.2.0

@theguild/tailwind-config 0.4.1

@types/react 18.2.76

typescript 5.4.5

Check this box to trigger a request for Renovate to run again on this repository

Remove `<PackageCmd/>` and write remark plugin to replace install snippets with `<Tabs />`

like docusaurus https://github.com/facebook/docusaurus/tree/main/packages/docusaurus-remark-plugin-npm2yarn

add `frontMatter.og-title`

we should improve components to add a new frontMatter prop - og-title so page title will be not changed

Bug: tag filter search feature no longer works on the envelop plugins page with the new new fuzzy matching search bar

Introduced from #674

Configurable og-image

Instead of hard-coding an og-image based on two properties provided by docs configuration title, websiteName, we should allow to provide a custom url to og-image.

It could be:

interface OgImageProps {
  title: string;
  description?: string;
}

config = {
  ogImage(props: OgImageProps) {
    return '....';
  }
}

We could use it like this:

config = {
   ogImage({title, description}) {
     return `https://.......?product=HIVE&title=${title}&extra={description}`;
   }
}

Why?

No need to pass product (ex value: HIVE) to the configuration and we could also experiment with additional text in the og-image or even completely different og-image.

Require meta > description on every page

Throw an exception or log an error when a page is missing a description.

Why?

SEO

[editor] Add OperationsEditor

We need OperationsEditor that has "Schema Awareness" and does validation based on the GraphQL schema.

Use-cases:

Envelop Playground
Codegen live-demo

We should be able to connect the OperationsEditor to SchemaEditor, something like:

const [schema, setSchema] = useState<GraphQLSchema>(null);

return (
   <div>
     <SchemaEditor value="" onSchemaChange={schema => setSchema(schema)} />
     <OperationsEditor value="" schema={schema} />
  </div>
);

Bring changelog to all websites

Maybe make it look like Product Updates from Hive

Copy button covers content

This is annoying when I want to copy-paste a specific line, but the copy button is covering the content 🥲

Links in navigation bar are not centered

React does not recognize the `accentColor` prop on a DOM elemen

bug while expand of `<Collapse />` in Firefox

cleanshot-2022-10-31-at-093308_jkckd2.mp4

Upgrading to v4

Hi, I am upgrading from @guild-docs/client to @theguild/components in GQty.

I found the current version of @theguild/[email protected] requires React 18, but it's dependency [email protected] wants React 16-17.

Which version of React shall I pick?

SSR issue with @theguild/components due to react-paginate dependency

storybook is broken?

Tried on chrome and safari and I just see a spinner.

Bug: clicking a result in Algolia search doesn't redirect

reference

Screen.Recording.2022-10-20.at.10.32.50.mov

line break toggle covers code block content

options dependency on useeffect

https://github.com/the-guild-org/the-guild-components/blob/c73c76cf3d937105ae0ade7b7b698fccb2c786bc/packages/monaco-graphql-editor/src/editor/use-schema-services.tsx#L126

Shouldn't you provide options as useEffect dependency?

fix og images for long title

and use https://github.com/shuding/react-wrap-balancer to nicely align text

bug: edit this page button doesn't redirect to the correct url for readme in Envelop plugins pages

So when clicking on the "Edit this page on Github" button on any of the pages for Envelop's plugins this for example. it redirects to the MDX component responsible for importing the markdown for each plugin as oppose to the plugin's readme URL.

add more `gap` for `<FeatureList />` in mobile

to fix use this class https://tailwindcss.com/docs/gap

`<a>` inside `<a>`

Figure out how to set `<title />` for dynamic pages that don't exist on disk

In Envelop all plugins retrieved with remote-mdx via getStaticPaths/getStaticProps in plugins/[name].mdx file.

Need find a workaround to set title since frontMatter.title is undefined and there is no first heading#

P.S. tried with NextHead but title rollbacks to frontMatter.title/first heading# that is undefined

export const PluginPage = () => {
  const { compiledSource, title } = useSSG()
  return (
    <>
      <Head>
        <title>{title}</title>
      </Head>
      <MDXRemote compiledSource={compiledSource} components={{ PackageCmd }} />
    </>
  )
}

Screen.Recording.2022-10-04.at.12.21.21.mov

Maybe we need to fix it in nextra

https://github.com/shuding/nextra/blob/a04c128c240fdc1fd43f8f1bb6961a0eb99872eb/packages/nextra-theme-docs/src/components/head.tsx#L23

to not render title tag if title is falsy

logo right click brand kit

When you right click on any logo we should provide the option to download the logo or go to a brandkit overview page, where people can download all our library and company logos as svg and png.

Search v2 improvements/bugs

"no result" when loading glitch
highlight color is missing opacity
display "⌘ K" or "Ctrl K" in the search input
overall better design
fix sorting of results (@charlypoly)
idea: add 1 record per "product" that rank first when searching for product name (ex: "Yoga" should display a result/card presenting Yoga, etc)
Algolia Insights seems to be broken 🤔 (https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-plugin-algolia-insights/createAlgoliaInsightsPlugin/)
Remove top imports when extracting content 🐞 (the-guild-org/the-guild-docs#658)

ERR_PNPM_LINKING_FAILED Error: EAGAIN: resource temporarily unavailable, copyfile

[niko@arch-phoenix docs]$ pnpm install
Scope: all 8 workspace projects
Lockfile is up to date, resolution step is skipped
Packages: +2358
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 ERR_PNPM_LINKING_FAILED  Error: EAGAIN: resource temporarily unavailable, copyfile '/home/niko/devel/.pnpm-store/v3/files/d2/32f24accb5a0a8167b68f28432b0f5a9b9837d22d06112f7de79e1f263f1e6dba2fff629e80ea054874e8579d19e06147991c4e0ba71ee302561263d9ae2cc' -> '/home/niko/devel/docs/node_modules/.pnpm/@[email protected]/node_modules/@algolia/client-personalization_tmp_479393/index.js'

After checking out master and running pnpm install I get this error.

Have a dropdown to get to other Guild libraries on each library website

cmd+k search shortcuts conflict with each other

Visit https://the-guild.dev/graphql/codegen and press CMD+K

Two search bars will open.

White flash on dark mode

mermaid on mobile kinda broken

https://guild-oss.slack.com/archives/C02M8QJ2WH3/p1686228441615179

navigation focus is cut off

When navigating with tabs the navigation highlight shadow/outline is a cut-off on the left and right side

Bug: seems like clicking on links takes longer to respond?

To reproduce:

Use any website
Click on a link
It takes a few seconds to get to the actual page. I think eventually it's not JS-loading the page and does a full page load.

Note: loading the page without a link, replies instantly.

Marketplace: search doesn't work well after pagination

to reproduce:

Go to the plugins hub / marketplace
navigate to page 2/3/4/5
use search and try to find something you know that exists
you'll see "no results" because it's using the items[pageNumber] thing to get the results.

to fix:
I guess the page number needs to be reset when you change the list of items?

[NEW FEATURE] - @theguild/remark-mermaid to support mermaidConfig as parameter

I am using Nextra and mermaid diagrams, which are great. However, to make the diagram fit into my needs, I always need to add to any diagram some init configuration, example

%%{
  init: {
    'themeVariables': {
      'fontFamily': 'trebuchet ms, verdana, arial',
      'fontSize': '14px'
    }
  }
}%%

I think it would be good if the plugin a mermaidConfig as variable

The Storybook link is broken

It leads to a 404.

think about update `graphql-language-service` to v4

Because in <OperationsEditor /> with graphql-language-service v4 when we select a field that has selection subfields curly brackets { and } add automatically, in v3 – not 😔 Look at the video

Screen.Recording.2021-12-10.at.16.34.35.mov

Things to make

import this enum directly from graphql-language-service as CompletionItemKind
LanguageService class is no longer present in graphql-language-service v3, install and import him from monaco-graphql package

There are also breaking changes that need to be fixed

LanguageService.getSchema and LanguageService.setSchema methods was removed, now there are getSchemaForFile and updateSchema methods
LanguageService.getDiagnostics is now sync

the-guild-org / docs Goto Github PK

docs's People

Contributors

Stargazers

Watchers

Forkers

docs's Issues

Edited/Blocked

Open

Ignored or Blocked

Detected dependencies

Why?

Why?

Things to make

There are also breaking changes that need to be fixed

Recommend Projects

Recommend Topics

Recommend Org