Skip to content
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

New guides & localization #30

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

MaXFeeD
Copy link

@MaXFeeD MaXFeeD commented Aug 2, 2024

  • Using docsify for easily pdf docs distribution
  • Added enchantments guide
  • Added liquids guide
  • Added toolchain guides
  • Added page contribution guide
  • Localized most pages on russian
  • Added 404 redirect back to docs
  • Typo, image pathes fixes

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 2: change to go to or even better read

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of grammar mistakes in general, to fix

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be better to comment on boolean abilities in the same style, either True, if ... or Whether the player ...

Copy link
Collaborator

@DMHYT DMHYT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor fixes required before merging

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • на базе Minecraft Bedrock Edition ...
  • для создания модов и игры с ними
  • & -> и

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Хорайзон - Horizon
  • HMK abbreviation is redundant, as it was never widely used

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Перейти в документацию -> Перейти к документации

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of grammar mistakes in general, to fix

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Multiple grammar mistakes to fix

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 3: maybe Pack contents sounds better?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Goto -> Go to

@@ -0,0 +1,83 @@
Before we start writing your mod page, we need to learn about Markdown format.
You can goto [this article](https://www.markdownguide.org/getting-started/) to learn what is Markdown.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can read this article...

Copy link
Collaborator

@DMHYT DMHYT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar fixes in create-page.md (unfinished, because some parts of text are just totally incomprehensible)


## Where we are

Before do anything determine what page will be created and which language(s) must included.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before doing anything, ... and which languages must be included


Before do anything determine what page will be created and which language(s) must included.

Every page at documentation described in markdown at *documentation/static/\<language\>* folder.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is described in Markdown

```txt
<language>
├─ README.md (index of current language, or nothing)
├─ page (most interesting thing, markdown content)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(the most interesting part - Markdown content)

├─ README.md (index of current language, or nothing)
├─ page (most interesting thing, markdown content)
│ ├─ apps (layout, e.g. Horizon and Inner Core)
│ ├─ guides (here placed everything about our game, e.g. attributes)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete here placed

└─ _navbar.md (e.g. switching between languages)
```

> Required folder that will be used to documentation doesn't appears here? Contact with maintainers to submit new location.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't appear

[REPOSITORY](https://raw.githubusercontent.com/AUTHOR/REPOSITORY/master/README.md ':include')
```

Some attentions before anything will be pull-requested:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some precautions before creating a pull request

Some attentions before anything will be pull-requested:

1. Corresponding markdown must be categorized by [description above](#where-we-are).
2. Do not use directly route to external content, links must be appeared only on page.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

???


1. Corresponding markdown must be categorized by [description above](#where-we-are).
2. Do not use directly route to external content, links must be appeared only on page.
3. Mod template / library page may exists only once, few occupants is not allowed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mod / library page can exist only once ...

1. Corresponding markdown must be categorized by [description above](#where-we-are).
2. Do not use directly route to external content, links must be appeared only on page.
3. Mod template / library page may exists only once, few occupants is not allowed.
4. Use `:include` in markdown only when you need include relative content or describe your mod template / library. Guides must be remain in this repository, to just build and use locally as documentation.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when you need to include ... Guides must remain ...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same fixes as in docs/ru/page/other/create-page.md

@MaXFeeD
Copy link
Author

MaXFeeD commented Aug 2, 2024

коммиты двух-трехлетней давности, можешь исправить орфографию если есть желание

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants