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

Move related pieces of documentation from wiki to Documentation/ #1746

Merged
merged 20 commits into from
Jul 20, 2023

Conversation

ia
Copy link
Collaborator

@ia ia commented Jul 19, 2023

  • Please check if the PR fulfills these requirements
  • The changes have been tested locally
  • There are no breaking changes
  • What kind of change does this PR introduce?
    Move related pieces of documentation from wiki to Documentation/.

  • What is the current behavior?
    Wiki is out-of-dated but still may have some valuable information to keep as project documentation.

  • What is the new behavior (if this is a feature change)?
    The single entry point into project documentation is online RtD generated site.

  • Other information:
    There are two things which I have a question about:

The updated current version can be surfed here. Basically, besides main index.md page & Hardware.md being updated a bit there is nothing else from wiki.

@Ralim
Copy link
Owner

Ralim commented Jul 19, 2023

I would drop the building notes from Wiki, they are hella out of date.
Would be good to keep TS80/P compatibility table though if we can :)

@ia
Copy link
Collaborator Author

ia commented Jul 19, 2023

I would drop the building notes from Wiki, they are hella out of date.

I had the similar suspicious but since I don't use STMCube nor Atollic it would take a lot of time to verify that info from wiki for actualization. Thanks for saving me time. ;)

Would be good to keep TS80/P compatibility table though if we can :)

No problem. I understand that it took a lot of time by community to gather all that info piece by piece so it would be a bit sad just to remove it. Plus as far as I remember it was around the times when there were all kind of not-so-honest vendors with self-made Quick-but-not-quite-Charge protocols (since it was a new thing back then) so you had to verify it before using. On one hand that situation with chargers/powerbanks using QC/PD luckily getting better and better with each year (i.e. they are more standardized these days), but I agree that this table may be useful for some users still.

scripts/IronOS-mkdocs.yml Outdated Show resolved Hide resolved
@ia
Copy link
Collaborator Author

ia commented Jul 19, 2023

Ok, I think I'm done with this one as well so far. So:

  • you can surf updated wiki here (don't forget to merge it from my repo manually as well after this PR merged1);
  • QC3/TS80 table will be look like this here (and I took some liberty to add a couple of little notes on PD, cables & phonies for new users);
  • Oh, and I added a couple of cross-references for convenience of surfing - from index.md to Power.md and from Power.md to PowerSources.md.

Footnotes

  1. I wouldn't delete the whole wiki section for IronOS project on github though - I would just keep that Home stub, for historical reason.

@ia ia requested a review from Ralim July 19, 2023 16:26
Documentation/Hardware.md Outdated Show resolved Hide resolved
Documentation/index.md Outdated Show resolved Hide resolved
@ia ia requested a review from Ralim July 20, 2023 01:31
@Ralim Ralim merged commit 1c9d394 into Ralim:dev Jul 20, 2023
@ia
Copy link
Collaborator Author

ia commented Jul 20, 2023

Aaand... but only when you have time - merge, please, default branch from this repo:
https://github.com/ia/IronOS-plus.wiki.git
to IronOS default wiki one:
https://github.com/Ralim/IronOS.wiki.git
🤝

@Ralim
Copy link
Owner

Ralim commented Jul 20, 2023

I did just edit wiki as I was lazy, did that work?

@ia
Copy link
Collaborator Author

ia commented Jul 20, 2023

I did just edit wiki as I was lazy, did that work?

Sort of... I think it looks fine now.

@ia ia deleted the wiki-to-rtd branch July 23, 2023 21:32
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