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

Generate a mkdocs github page + Migrate documentation links to use it #1414

Merged
merged 13 commits into from
Sep 22, 2022
Merged

Conversation

Ralim
Copy link
Owner

@Ralim Ralim commented Sep 21, 2022

  • 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?
    Making documentation nicer to read
    Serves nicer docs at https://ralim.github.io/IronOS/

  • What is the new behavior (if this is a feature change)?

  • Github action automatically updates documentation on merge into dev

  • Links are updated from linking to the .md files to instead point to the new docs page

@Ralim
Copy link
Owner Author

Ralim commented Sep 21, 2022

@discip @river-b
I think you two are the main ones I'd love to double-check this.
If its a thumbs up from you, it would be great.

Its all still made from those .md files that we have had before and then the mkdocs.yml file defines the menu down the left side.

I'm thinking the new setup with that menu should make organisation and access easier.

@discip
Copy link
Collaborator

discip commented Sep 21, 2022

Greetings,
generally speaking: Automation is highly welcome!
Otherwise, I will have to go through it later, since I am currently at work.

@Ralim
Copy link
Owner Author

Ralim commented Sep 21, 2022

No rush, happy to wait for people to have a look :)

@Ralim Ralim merged commit 6fab3e5 into dev Sep 22, 2022
@Ralim Ralim deleted the docs branch September 22, 2022 03:10
@discip
Copy link
Collaborator

discip commented Sep 22, 2022

Sorry for being slow. 😅

I only managed to get a glimpse of what you did.

  1. Automation is your territory anyway, so I did not even bother checking that.

  2. Content wise:

    1. I think there is nothing new.

    2. But one thing confused me a bit.
      As you know I do not like redundancies especially regarding information.

    In your PR there are 2 sets of .md files.
    If you plan on moving documentation to this new (much more appealing) location, then a temporary redundance is no problem. But in the long run one set of .md's should be removed. This is just my opinion though.

Also there is, at least I spotted only that one, a formatting issue to be found here: DebugMenu, at the very bottom of the page.

Other than in the original DebugMenu.md, the last sentence is not enclosed in a border.

@Ralim
Copy link
Owner Author

Ralim commented Sep 25, 2022

Yeah nothing new added, just setting up automation to take the contents of the Documentation folder and turn it into the docs site.

There is only one "set" of .md files, but a bunch of noise from me moving them around.
Any changes we make to the .md files in the Documentation folder will be pushed through via this automation once merge.

I will have to look into the formatting issue

OctopusET pushed a commit to OctopusET/IronOS that referenced this pull request Oct 27, 2022
…Ralim#1414)

* Approx first pass?

* Update docs.yml

* Filling out menu

* Update GettingStarted.md

* Index docs links

* Update index.md

* Update README.md

* Link redirection

* More link rewrite

* Update HallSensor.md

* Split up flashing

* Derp

* Flashing links
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