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

docs: add first week & forest survival #3190

Conversation

RoyalFox2140
Copy link
Collaborator

Summary

SUMMARY: [Infrastructure] "Add two documents to the doc site"

Purpose of change

I'd like to add new documents to the doc site, @scarf005 checking in this test to make sure this is the correct file location

Describe the solution

Adds the two files.

Describe alternatives you've considered

Letting the arcane secrets of Bright Nights remain forbidden to new practitioners.

Testing

If this finds a way to break the releases I'd be impressed on a cosmic level

Additional context

N/A

two doc pages for new players
Copy link
Member

@scarf005 scarf005 left a comment

Choose a reason for hiding this comment

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

For survival guides, doc/src/content/docs/en/game could be a good choice, as this path is intended for gameplay related pages (lore, guide, mod links).

@scarf005
Copy link
Member

I'll also keep it as draft until the docs are complete.

@scarf005 scarf005 marked this pull request as draft September 21, 2023 00:28
@RoyalFox2140
Copy link
Collaborator Author

For survival guides, doc/src/content/docs/en/game could be a good choice, as this path is intended for gameplay related pages (lore, guide, mod links).

I see this now and that's my bad since I was going off the video guide. I'm going to move them and keep working on it. I wanted to make sure I at least got the format and location correct before I lost any work

@scarf005
Copy link
Member

yeah, the format's good.

moved the docs to the recommended folder, first rough draft was created
@scarf005 scarf005 self-requested a review September 22, 2023 15:49
@RoyalFox2140 RoyalFox2140 marked this pull request as ready for review September 22, 2023 15:49
Copy link
Member

@scarf005 scarf005 left a comment

Choose a reason for hiding this comment

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

Congrats for joining the first contributor for the revamped docs. i've made change requests regarding formatting (that i missed writing on docs.md). if you're okay with it, i'll format, re-organize and approve them tomorrow.

RoyalFox2140 and others added 2 commits September 22, 2023 15:56
Co-authored-by: scarf <greenscarf005@gmail.com>
no heading 1 got it

Co-authored-by: scarf <greenscarf005@gmail.com>
@RoyalFox2140
Copy link
Collaborator Author

Congrats for joining the first contributor for the revamped docs. i've made change requests regarding formatting (that i missed writing on docs.md). if you're okay with it, i'll format, re-organize and approve them tomorrow.

Please add all formatting things (heading 1's can't be used, we're going with - instead of * or +) in the guide for contributing docs.

RoyalFox2140 and others added 2 commits September 22, 2023 15:58
Co-authored-by: scarf <greenscarf005@gmail.com>
suggestions from scarf added
@scarf005 scarf005 self-assigned this Sep 23, 2023
@scarf005 scarf005 self-requested a review September 23, 2023 02:39
Copy link
Member

@scarf005 scarf005 left a comment

Choose a reason for hiding this comment

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

Rendered pages

First week

image

Forest survival

image

I made some edits to your guides, is this OK with you?
Should i rollback checklist?

@RoyalFox2140
Copy link
Collaborator Author

Rendered pages

First week
Forest survival
I made some edits to your guides, is this OK with you? Should i rollback checklist?

That may be going with too many sections but if its more readable then it looks good to me

@scarf005 scarf005 merged commit d8896f2 into cataclysmbnteam:upload Sep 23, 2023
@RoyalFox2140
Copy link
Collaborator Author

I was concerned with adding too many headings and sections due to making the pages extremely long and hard to read through, but I understand making large paragraphs is not very readable either. If we go with many sections and headings that's ok with me, but we will want to add this officially to the style guide for docs

@scarf005 scarf005 mentioned this pull request Sep 23, 2023
@RoyalFox2140 RoyalFox2140 deleted the Docs-first-week-plus-forest-survival branch December 10, 2023 16:27
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