bedrock-oss/bedrock-wiki

Rewrite of the Bedrock Wiki.

Bedrock Wiki

Welcome to the Bedrock Wiki!

🔗 View the Site 🔗

✉️ Join the discord ✉️

This wiki is a knowledge-sharing website for Technical Bedrock, containing documentation, tutorials, and general how-to information.

Contributing

You've found a typo, couldn't get along with a guide because it was too complicated or want to write your own guide to help other users create their own addons? Then you've come to the right place!

Our Bedrock wiki is fully open source and is maintained by our lovely community. And this community grows every day! If you want to be part of this community, get help on addons or just want to expand our wiki, you can join our Discord servers:

Bedrock OSS - for wiki contributing and cool projects, Bedrock Add-Ons - for add-on help.

If you want to help us create more complex things, like adding a new page or fixing some typos yourself, we have a dedicated Contribute Page on our wiki, which describes every step you need to follow. If you have some questions, there are some really nice people in our Discord Server.

Code and Platform

The wiki uses a custom VitePress theme, and is statically generated from the wiki branch into the generated branch.

If you are interested in helping us maintain the core platform, as opposed to the markdown articles, join the discord!

bedrock-wiki's Issues

Create MoLang snippets page with MoLang Grapher integration

Source for functions

Ideally, it should be a component, that takes in a MoLang expression and renders a graph of this expression with expression being syntax highlighted.

Spacing for Contributors widget

Top-level categories in sidebar does not appear to have `nav_order`

Create more markdown-friendly file-path display

Current version requires going through external editor, and leaves a very messy HTML block in the markdown. Can we somehow generate this more cleanly, for example embedding the external parser into the actual build pipeline?

Please note the 1.1 release milestone.

Light rounding on inline code-blocks

The rounding is pretty intense right now:

It doesn't need to be sharp-square, but right now it stands out, I think.

Sidebar generation broken

Since the "index.md" files have been removed from each category, the generateSidebar() function is no longer pushing categories without this file to the sidebar data.

Design Vue component for giving images visible titles

Please note 1.1 Milestone

Move tasks from readme, into github issues

Some tasks are finished, but not marked as complete. Verify completed tasks, then move them into issues. The readme can be edited at that time, to remove the list of open issues.

Please set everything to Milestone 1.0 release. I will groom later if some things can be done later.

Rethink icon badges

For now, as far as I understood, the icons are:

• Graduate hat = Guide
• Chemistry glass = Recipe
• Warning sign = Experimental
• Left without icons: Beta, New

I think it should be like that:

• Graduate hat = Guide (left as it is)
• Chemistry glass = Experimental
• Warning sign = Beta OR something really unstable and dangerous OR deprecated
• Deprecated also can be represented as a tombstone

Also, I think it would be ok to use whole words for New and Beta, but without colorful badges

Add search

add searching

Show sidebar pip in-page as well

Currently we need to write it into the title, or add it below as a widget. Can we just make sidebar pips display in the title too?

Adjust spacing across all elements for consistancy and readability

Design proper 404 page

Current 404 is just "HELLO YOU TOOK A WRONG TURN".

For example https://bedrock-oss.github.io/bedrock-wiki-vite/docume

Relates to #17

Theme-switcher cannot be clicked on the chevron

Can't click on orange area, which is most natural place to click:L

Create "copy code" button for code-blocks

This can wait till 1.1:

Close all other sections when one section is opened

Prevents this kind of issue, where the sidebar is just completely overwhelming.

Add visual indication that "copy" button works in code-blocks

Currently there is no visual feedback or animation to show the button was pressed.

Please note the v1.1 Milestone.

Create better styling for light-theme code-blocks

Currently, they share a theme:

Aggresive wrapping on titles, when labels are included

Titles are wrapping too aggressively when there is a label.

Add ability to add contributors over frontmatter

The idea here is to have something like the following in the front-matter:

contributors
 - github URL
 - github URL

This should get merged with the build-time contributors, so we can credit people who may have been lost from the git history.

Design a kick-ass home-page

We are rebranding... lets show it!

Lets give some love to our home-page, and make it pop so people want to stay on the site.

Sign up for proper Algolia Search

Fix code headers

Some code block headers were transferred incorrectly and now need to be fixed.

Address width on large-screen monitors.

Also gives us a chance to make space for a right-hand-based TOC. Relates to #14.

Hide pages from nav/sidebar, using front-matter

I don't know if this feature already exists, but it would be very helpful for us in the future!

Port/create Table of Contents

The old-wiki had a really cool TOC that moved from top-of-page (mobile) to right-of-page (desktop).

Fix light-theme background

Light-theme background is currently using pure-white, I think. We should set it to something more pleasing, to prevent Firefox (and other browers/plugins) from adjusting it.

The feature is intended to replace "bright white" loading screens, and generally should not edit a page unless its without CSS (like a plain-HTML website.

The error here is that we aren't styling it (leaving it white), so Firefox is treating it like a bright-white loading screen.

Prevent unicode symbols from being parsed on Emoji Page

Page: https://bedrock-oss.github.io/bedrock-wiki-vite/documentation/emojis.html

Maybe not worth worrying about. Please note 1.1 milestone.

Write 404 resolver for redirecting links

This can wait until 1.1, since we will be doing a giant reorganization of the content, after the platform is complete.

Some form of image-sizing

Not sure how/if we want to approach this, but currently images can be as large as they want.

Pixelated image-macro no longer works

This used to turn off filtering, for small images. I think.

Only fetch contributor data during build

Currently, a fetch request happens upon navigating to a page which is unnecessary because the contributors data cannot change independently from the page.

Move logic to config.js file instead

Better collapsables

Currently collapsible are very meh. Can we do a Vue component?

Set to v1.1, even though I would love it in 1.0.

Sidebar does not scroll properly when lots of sections are expanded

If you expand a lot of sections, the bottom of the sidebar is cut off, meaning its impossible to scroll to all content.

CSS: Increase spacing above tables

Vue Notification System

Create a system for notifications to give users feedback (e.g. successfully copying code snippet)

Make dark theme more visually pleasing

The dark theme seems a bit to contrasty and could do with more matching to the jekyll wiki's dark theme

Mobile support

Currently, the sidebar hides in mobile view, but the hamburger menu can't be clicked, and generally the top bar gets quite cramped:

Vue Button Component

Create a button component that can be reused across the project with feedback upon click, support for mixed icon/text usage etc.

Create/Port contributors widget

Make more interesting styling for checkboxes

@KaiFireborn I assigned you here, since this would mostly impact the guide, and I thought you might be interested. Feel free to remove yourself.

I also put it at v1.1 milestone, so there isn't any rush.

Invalid usage of CodeHeader

Link: https://bedrock-oss.github.io/bedrock-wiki-vite/documentation/emojis.html#custom-emoji

Drop-down CSS (tailwind?)

Current drop-down doesn't look amazing. Can we properly implement tailwind classes, to make it match Bedrock.dev?

Mobile support: Add header links into sidebar, or display them some other way.

Removing them from top bar was intentional, but we need to put them somewhere else.

Please note 1.1 Milestone.

Fix/style the Unicode-Converter on the Emojis page

This can also be just removed if you don't want to bother.

Remove old `index.md` from each category

For example https://bedrock-oss.github.io/bedrock-wiki-vite/concepts/index.html

JQ Embeds have weird styling

Mobile Support: Dynamic scaling for <H> tags

We need some kind of dynamic scaling, since right now we are getting very large headers. Images for comparison.

Make Vite the live site

Should we move into the old repo?

Just switch the domain registration over?

Backmerge wiki edits from last 2 months.

After splitting, pages have been edited, and new pages added.

Most likely needs to be done by hand, although it won't be too much work because there wasn't that many commits, I think.