Skip to content

feat: Add Adventure docs #573

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

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

Strokkur424
Copy link
Contributor

@Strokkur424 Strokkur424 commented Apr 20, 2025

Redo of #569.

Differences between the current Kyori docs:

  • Whilst the index pages exist path wise, they aren't directly accessible via the side bar. I am not sure how, or even if it is possible, to do that, so that's something for scorp to fix 😀.
  • On a few of the serialiser pages (only on those where a dependency is displayed via the <AdventureDependency /&mt; tag, I had to add an extra code block displaying the way to retrieve an instance, as without a code block, the imported code block is not rendered correctly. This seems to be an Astro/expressive-code related bug, but I still needed a non-intrusive workaround. reported, waiting for fix
  • On the MiniMessage format page, certain screenshots are aligned/sized slightly differently than in the Kyori ones. If desired, I can try to conclude more parity, but that wasn't a priority when I initially wrote the docs.

TODO:

  • Add slugs to pages
  • Inline code block syntax highlighting (low priority)

Blocked on:

Copy link

github-actions bot commented Apr 20, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview b7a6bb2

@Strokkur424 Strokkur424 force-pushed the feat/adventure branch 3 times, most recently from ce0ed19 to d876719 Compare May 14, 2025 19:46
@zlataovce zlataovce self-assigned this May 14, 2025
@Strokkur424 Strokkur424 force-pushed the feat/adventure branch 2 times, most recently from 16ad110 to 300014f Compare May 14, 2025 20:41
@zlataovce zlataovce marked this pull request as ready for review June 1, 2025 10:05
@olijeffers0n olijeffers0n self-requested a review June 1, 2025 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted type: feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants