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: remade the linux.md page. #875

Closed
wants to merge 2 commits into from
Closed

docs: remade the linux.md page. #875

wants to merge 2 commits into from

Conversation

Jaskowicz1
Copy link
Contributor

This PR remakes the linux.md page, basically taking the old buildcmake.md page and adding it here (but, ofc, improved), meaning the page now covers g++ and CMake. This PR also merges the changes on linux.md from #820.

Documentation change checklist

  • My documentation changes follow the same style as the rest of the documentation and any examples follow the coding style guide.
  • I tested that my change works before raising the PR (via running oxygen, and testing examples).
  • I have not moved any existing pages or changed any existing URLs without strong justification as to why.
  • I have not generated content using AI or a desktop utility such as grammarly.

@netlify
Copy link

netlify bot commented Sep 21, 2023

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit efbb52b
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/650ca96ead16ef00084b3b7a
😎 Deploy Preview https://deploy-preview-875--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.

Copy link
Contributor

@braindigitalis braindigitalis left a comment

Choose a reason for hiding this comment

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

not sure we should be merging the pages together... it means duplicated content on Google which is bad and means two places to maintain.
simply link to the cmake guide at the bottom as we did before?

@Jaskowicz1
Copy link
Contributor Author

not sure we should be merging the pages together... it means duplicated content on Google which is bad and means two places to maintain. simply link to the cmake guide at the bottom as we did before?

They're not the same. The CMake guide no longer uses source, the new addition here shows CMake with source. Ideally, I'd like two separate pages, unless you can come up with a better idea!

@braindigitalis
Copy link
Contributor

not sure we should be merging the pages together... it means duplicated content on Google which is bad and means two places to maintain. simply link to the cmake guide at the bottom as we did before?

They're not the same. The CMake guide no longer uses source, the new addition here shows CMake with source. Ideally, I'd like two separate pages, unless you can come up with a better idea!

problem is this a guide on how to build the lib and now it's also a guide on how to build a bot... the lines are blurred and it isn't so clear any more. perhaps a separate new page for it that this one links to?

@Jaskowicz1
Copy link
Contributor Author

not sure we should be merging the pages together... it means duplicated content on Google which is bad and means two places to maintain. simply link to the cmake guide at the bottom as we did before?

They're not the same. The CMake guide no longer uses source, the new addition here shows CMake with source. Ideally, I'd like two separate pages, unless you can come up with a better idea!

problem is this a guide on how to build the lib and now it's also a guide on how to build a bot... the lines are blurred and it isn't so clear any more. perhaps a separate new page for it that this one links to?

Yeah that's actually a good point, I didn't really think of that. So, if we're to make a separate page for building a bot using source with CMake, where would we place that? I don't think placing it next to the buildcmake.md page is a good idea.

@braindigitalis
Copy link
Contributor

not sure we should be merging the pages together... it means duplicated content on Google which is bad and means two places to maintain. simply link to the cmake guide at the bottom as we did before?

They're not the same. The CMake guide no longer uses source, the new addition here shows CMake with source. Ideally, I'd like two separate pages, unless you can come up with a better idea!

problem is this a guide on how to build the lib and now it's also a guide on how to build a bot... the lines are blurred and it isn't so clear any more. perhaps a separate new page for it that this one links to?

Yeah that's actually a good point, I didn't really think of that. So, if we're to make a separate page for building a bot using source with CMake, where would we place that? I don't think placing it next to the buildcmake.md page is a good idea.

bury it at the bottom of this one with a hyperlink to it so that you have to be looking for it to find it, this encourages people by default to install how we can support them easier, same way we funnel them towards the windows template.

@Jaskowicz1
Copy link
Contributor Author

not sure we should be merging the pages together... it means duplicated content on Google which is bad and means two places to maintain. simply link to the cmake guide at the bottom as we did before?

They're not the same. The CMake guide no longer uses source, the new addition here shows CMake with source. Ideally, I'd like two separate pages, unless you can come up with a better idea!

problem is this a guide on how to build the lib and now it's also a guide on how to build a bot... the lines are blurred and it isn't so clear any more. perhaps a separate new page for it that this one links to?

Yeah that's actually a good point, I didn't really think of that. So, if we're to make a separate page for building a bot using source with CMake, where would we place that? I don't think placing it next to the buildcmake.md page is a good idea.

bury it at the bottom of this one with a hyperlink to it so that you have to be looking for it to find it, this encourages people by default to install how we can support them easier, same way we funnel them towards the windows template.

I like that idea haha. However, if it's not listed as a "subpage" anywhere, it'll become a top page (like FAQ) so it needs to be under some sub-section. I think we should also have a discussion about the linux template, if you're available for that :)

@Jaskowicz1 Jaskowicz1 closed this Sep 23, 2023
@Jaskowicz1 Jaskowicz1 deleted the build-linux-changes branch September 25, 2023 19:54
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