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

Firmware / Clean up deprecated files and improve documentation links for firmware #1632

Merged
merged 3 commits into from
Jan 4, 2025

Conversation

z3ugma
Copy link
Contributor

@z3ugma z3ugma commented Jan 3, 2025

Addressing lots of confusion in Discord about the difference between firmware v1.5 vs firmware v1.0

Remove unused firmware v1.5 folder
Remove old build artifact uf2 files; update firmware root README
Remove deprecated bootloader uf2 and hex files
Update README.md in firmware_v1.0 to link to docs website instead of duplicate local instructions.

@beastoin
Copy link
Collaborator

beastoin commented Jan 4, 2025

cool, btw 1/ instead of removing them, let's move them to a new folder Friend/firmware/deprecated/

@z3ugma

@z3ugma
Copy link
Contributor Author

z3ugma commented Jan 4, 2025

@beastoin If you ever need to go reference the files you can use git to pull the older files from the commit history. Having them around in a deprecated folder causes confusion for newcomers that don't understand why there's a deprecated folder. I'm really hoping to reduce newcomer confusion which is rampant on the Discord.

If you insist then I'll rebase to move them to a deprecated folder.

@beastoin
Copy link
Collaborator

beastoin commented Jan 4, 2025

i see. btw the deprecated folder is super clear to understand what it is. besides that, someone may need to recall them and wont be suprised because it's not there anymore.

so lets move them to deprecated folder first then we will do the clean process (remove the deprecated) in the next 3 months.

what do you think ?

@z3ugma

@z3ugma
Copy link
Contributor Author

z3ugma commented Jan 4, 2025

Sure, let me rebase and update the PR

@z3ugma
Copy link
Contributor Author

z3ugma commented Jan 4, 2025

@beastoin rebased and moved the source files into a deprecated/ folder

@z3ugma
Copy link
Contributor Author

z3ugma commented Jan 4, 2025

one more plug/pitch for just deleting it to avoid confusion from the Discord, @francip was also fine to delete it.

Franci Penov — 1/1/25, 3:21 PM
Go ahead. I have this in my PR as well, but I can merge. We will never need that folder, btw, there's nothing there of use.

@beastoin beastoin merged commit 562de55 into BasedHardware:main Jan 4, 2025
@beastoin
Copy link
Collaborator

beastoin commented Jan 4, 2025

lgtm @z3ugma 🚀

@francip
Copy link
Collaborator

francip commented Jan 15, 2025

#1694

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.

3 participants