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

How to docs and fixes to be added to the mdbook documentation site #5070

Merged
merged 4 commits into from
Aug 5, 2024

Conversation

anrichtait
Copy link

@anrichtait anrichtait commented Jul 31, 2024

Description

  • Copied most of the wiki docs over for the new mdbook site
  • Fixed some formatting errors
  • Changed relative paths to links to avoid errors (I have a script that does this automagically, I can send it on discord if anyone wants/needs it.

Images/Links

Issue(s) that this PR fixes

  • Format issues with some of the files, i.e Headings not being consistent.
  • Broken file paths have been changed to links so if these docs are moved in the future the relative paths will no longer be an issue.
  • Lack of documentation on the new site
  • Wrong files listed in How to add a new trainer, it was originally listed as trainer.c not trainers.h which sent the reader to a non existent file in the GHub

People who collaborated with me in this PR

Original Commits to wiki

  1. ghoulslash - AI Logic, New battle script commands/macros
  2. AsparagusEduardo - All the "How to add pokemon docs"
  3. CancerFairy - How to add new move
  4. LucaBGt and hedara90 - How to add a new trainer class
  5. rylawesome and LOuroboros - Infinite Repel Item
  6. hedara90 - Testing System

Feature(s) this PR does NOT handle:

Files still needing to be moved over:

  • About the project
  • Addenda
  • Credits
  • Expansions Improved Switch AI
  • Totem Boosts
  • Tutorials

Discord contact info

toonv#26526

@AsparagusEduardo
Copy link
Collaborator

Quick update to the description to properly credit CancerFairy for their move tutorial :)
(can't fully look at the PR right now)

@anrichtait
Copy link
Author

New commit to the PR is just to make sure there are no conflicts after the last update to the master branch. I pulled the changes this morning (South Africa time)

@AsparagusEduardo
Copy link
Collaborator

AsparagusEduardo commented Aug 5, 2024

I was about to merge this with the goal of polishing up the documentation in future PRs, but I'm not sure if we should include the Infinite Repel item article as part of it, as it is not a feature supported by the team. I believe it'd be better to remove it from this PR.

@anrichtait
Copy link
Author

supported

No problem, I'll remove it. Let me know what I can change in the rest of the documentation, my morning is pretty open today.

Copy link
Collaborator

@AsparagusEduardo AsparagusEduardo left a comment

Choose a reason for hiding this comment

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

Last thing that I would change for now.

docs/SUMMARY.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@AsparagusEduardo AsparagusEduardo left a comment

Choose a reason for hiding this comment

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

Meant to click "Request changes"

@AsparagusEduardo AsparagusEduardo merged commit fd3cb6f into rh-hideout:master Aug 5, 2024
1 check passed
@Bassoonian Bassoonian added the type: documentation Improvements or additions to documentation label Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants