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: refactored page links #808

Merged
merged 15 commits into from
Aug 27, 2023
Merged

Conversation

Commandserver
Copy link
Member

@Commandserver Commandserver commented Aug 26, 2023

  • My pull request is made against the dev branch.
  • I have ensured that the changed library can be built on your target system. I did not introduce any platform-specific code.
  • I have ensured that all methods and functions are fully documented using doxygen style comments.
  • I tested my commits, by adding a test case to the unit tests if needed
  • I have ensured that I did not break any existing API calls.
  • My code follows the coding style guide (if you are not sure, match the code style of existing files including indent style etc).
  • I have not built my pull request using AI, a static analysis tool or similar without any human oversight. Where I have generated this pull request using a tool, I have justified why this is needed.

Why? because doxygen uses the filenames to generate the links when we don't use \page, and that's ugly e.g. md_docpages_04_building_a_bot.html should be just building-a-bot.html shouldn't it?.

There're many ways to link a page e.g.: [Shards](\ref clusters-shards-guilds) or \ref clusters-shards-guilds "Shards", which i've used for this pr.

I've tested all links to make sure they're working.

@netlify
Copy link

netlify bot commented Aug 26, 2023

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit a399d06
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/64e9e7383246d20008f0ba89
😎 Deploy Preview https://deploy-preview-808--dpp-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Jaskowicz1
Copy link
Contributor

Jaskowicz1 commented Aug 26, 2023

So, does \ref mean references will work when we run doxygen locally? I remember you mentioning "ref" in one of my PRs but I had no idea of it.

If so, I'm so all for this PR and I will be praising you forever 😆

@Commandserver Commandserver added the documentation Improvements or additions to documentation label Aug 26, 2023
@Commandserver
Copy link
Member Author

Commandserver commented Aug 26, 2023

So, does \ref mean references will work when we run doxygen locally? I remember you mentioning "ref" in one of my PRs but I had no idea of it.

If so, I'm so all for this PR and I will be praising you forever 😆

Yes

@Jaskowicz1
Copy link
Contributor

Yes. they're better as we don't hard-code a filename. So when we rename a page, we don't have to change all links with it.

This is absolutely amazing then, thank you a lot!!

@Jaskowicz1
Copy link
Contributor

Checked through every page to see if anything was missing and there isn't! I'm more than happy with this PR :)

@braindigitalis braindigitalis merged commit effd719 into brainboxdotcc:dev Aug 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants