-
Notifications
You must be signed in to change notification settings - Fork 1
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
feat: new website for mercurius #1
base: main
Are you sure you want to change the base?
Conversation
9619dfd
to
b67231f
Compare
b67231f
to
7bc56e7
Compare
This is awesome, I'll have a look and play with it in a bit! |
This is good, however we'd need support for multi-version similar to what Fastify has: https://github.com/fastify/website/blob/main/scripts/download-releases.sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had a play and looks great!
In addition to the suggestion above around versioning, it might be worth bearing in mind integrating documentation from other plugins - however this is most likely a v2 thing! :)
You can remove old versions, just keep the last two. |
I have added the following versions of Mercurius ( see screenshots )
I had to fix some of the titles so they were in line with the other titles in the sidebar and I removed the @mcollina as soon as you have time, let me know If it's okay 🙂 |
I added buttons to add a star to the mercurius project and a button to fork the mercurius project. I would say we should be there 💪😉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just played with it locally and I found the following issue:
- The link in the footer appears to be incorrect?
After looking a little closer, and after running npm run build
, I found the following broken links?
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/hooks.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/api.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-latest/hooks.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-latest/api.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/hooks.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/api.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/typescript.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/hooks.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/hooks.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/api.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-latest/hooks.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/hooks.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-latest/api.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/api.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/typescript.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/hooks.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/api.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/api.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
Other than that, looks fantastic! :)
Link fixed see commit here: 8cd1562 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Awesome stuff, looking forward to seeing it in action!
I also made the one for Pino Logger, if you want to have a look at it: pinojs/website#1, very similar to the one by Mercurius, is awaiting review, hoping it will be approved |
I need to catch up on this, sorry :( |
No problem, as soon as you have time 😉 |
issue: mercurius-js/mercurius#1112