226 Commits

Author SHA1 Message Date
Ben V. Brown
009aa10a53 Fix docs gen check (#2139)
* Adding CI check to prevent settings docs drift
* Fixup gen_menu_docs
* Generate new settings docs
2025-07-16 16:03:26 +10:00
Ben V. Brown
260891b00b Adding documentation around debugging PD PSU's (#2111)
* Create USB-PD Debug docs

* Add to menu

* Update DebuggingPD.md
2025-07-07 14:49:48 +10:00
protato7
0f3e03e7cf blisp typo in Logo.md (#2129) 2025-05-22 22:12:01 +00:00
nomakewan
8d40afcaa1 Add missing dependency (#2118)
img2logo.py has IntelHex as a dependency which is not installed by default with Python3 or Pillow and so should be specified explicitly in the instructions.
2025-04-14 01:50:21 +00:00
Philippe Teuwen
83aa1b6425 Adding Pinecilv2 ws2812b mod option (#2099)
* support for WS2812B mod on Pinecil v2

* document support for WS2812B mod on Pinecil v2

* update IronOS-mkdocs.yml

* Protect WS2812B_Pin with define WS2812B_ENABLE
2025-03-06 22:36:01 +03:00
Ben V. Brown
622d8aac07 Add some PinecilV2 troubleshooing notes 2025-02-23 13:02:57 +11:00
Ivan Zorin
68aac2847b Debug Menu: update documentation about timestamp format 2025-02-13 07:59:20 +03:00
Leo
08ff68cd4f Added guide for compiling under Windows (#2060)
* Update documentation to build IronOS in Windows using MSYS2 environment and fix compilation on case-sensitive file systems.

---------

Co-authored-by: Ivan Zorin <ivan.a.zorin@gmail.com>
2025-02-08 00:03:49 +03:00
Steven Seifried
1d9b16e963 Typo corrected (Squire -> Sequre) 2024-12-22 08:42:20 +01:00
Ivan Zorin
d16d6eca42 Manage Belorussian langauge as part of cyrillic multilang builds 2024-11-28 21:27:31 +03:00
Ivan Zorin
26c50d7962 Check the presence of changelog for the latest stable release in History.md (#1999)
* Documentation/History.md: update version format according to git tag for easiest automation

* Add test check for changelog of the latest stable version

* Add git config permissions routine to test docs via push.yml

* scripts/deploy.sh fixes

* making shellcheck happy due to false negative in deploy.sh

* push.yml: fetch tags for test docs

* push.yml: set fetch depth trying to get tags

* deploy.sh printf debugging

* deploy.sh: remove printf debugging

* push.yml: rename step from check_readme to check_docs to reflect its function
2024-11-21 20:16:02 +11:00
Ivan Zorin
7dd5325716 Add info about v2.22 to History.md (#1993)
* docs/History.md: add info about v2.22

* docs/History.md: unify titles styling of markdowned headlines
2024-11-14 20:52:02 +11:00
Ben V. Brown
a0a779faba Custom tip type selection (#1977)
* Minor doc updates

* pydoc

* Draft tip selection menu

* Start linking in manual tip resistance

* Enable on Pinecilv1 / TS10x

* Fixup drawing tip type

* Update Settings.cpp

* Rename JBC type

* Add translations

* Handle one tip type

* Refactor header includes

* Fixup translation_IT.json

* Fixing up includes

* Format

* Apply suggestions from code review

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update Documentation/Hardware.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

---------

Co-authored-by: = <=>
Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2024-11-01 12:20:33 +11:00
discip
785a6a01ca Update Power.md 2024-08-24 13:11:51 +02:00
Ben V. Brown
11beddf5e6 TS1010 Logo rework for Miniware DFU (#1967)
* Move LOGO and settings to suit Miniware DFU

* Update configuration.h

* Adjust TS101 logo to 99K offset

* Add logo note/instructions for TS101
2024-08-22 12:11:51 +10:00
DSikes
ac0cd2a61d Added description of how to get around common error under Windows section of installation guide
Added a message about how to get around windows dialog prompt when copying from NTFS filesystems (Most of what Windows users will be copying from) to FAT which the iron uses.

This is an extremely common problem for Windows users, and I'd like to put in a tested workaround in the guide as it would have saved me about 15 minutes on what would have been a 20 second install.

I believe this will be of similar benefit to most Windows users.
2024-04-10 06:17:53 -04:00
Ben V. Brown
20bb895253 Update porting guide + cleanups (#1898)
* Update porting guide + cleanups

* Documentation/README.md: update autogenerated file
2024-04-03 14:00:44 +11:00
Ben V. Brown
21a1012102 Add rough pass on porting support (#1874) 2024-02-18 09:31:21 +11:00
Ivan Zorin
c97e3eb29b Updating references in the docs (#1843)
* Documentation: add links to firmware mirror backup [#1840]

* Documentation/Flashing: replace out-of-dated external wiki links by internal references

* Documentation/Flashing: add missing space
2023-11-23 19:23:20 +11:00
Ivan Zorin
f914240cad Update links to the original Miniware firmware [#1840] (#1842) 2023-11-22 09:36:38 +11:00
Ivan Zorin
53bb8355f8 docs/History.md: add info for 2.20 & 2.21 (#1804)
docs/changelog: update info for 2.20 & 2.21
2023-08-20 09:55:38 +10:00
Ivan Zorin
5754622fea Include History.md to online docs as Changelog (#1799)
docs/changelog: include History.md to read-the-docs site generating as Changelog, update titles formatting & unify style between sections
2023-08-16 10:06:55 +10:00
Ivan Zorin
4cb47cf1a2 Add detailed OLED replacement info to Troubleshooting document (#1797)
* Add OLED replacement info to HardwareIssues document

* Update formatting & text

* Move OLED replacement detailed info from HardwareIssues to Troubleshooting inside the related section
2023-08-14 11:12:52 +10:00
Ivan Zorin
33439aaa22 Include Bluetooth document to read-the-docs site generating (#1798) 2023-08-14 11:11:54 +10:00
Ben V. Brown
c0f1c35ba5 Update logo flashing information (#1787)
* Update logo information

* Update Documentation/Logo.md

---------

Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-08-08 09:45:54 +10:00
Ivan Zorin
15ab87f3bc Update tagging for detached commit case & update docs (#1783)
make_translation.py: update tagging for detached commit case & update docs
2023-08-07 09:05:56 +10:00
Ivan Zorin
97c0fee358 Implement proper git SHA ID marking for builds during pull-requests (#1772)
* debug github CI git meta info

* fix push.yml format

* fix push.yml for shell

* try to fix push.yml

* try to fix push.yml run

* try to fix push.yml run for multi

* keep debugging

* try to do as less changes as possible

* Implement proper git tagging for builds during pull-requests

* Unify new-line separators between build steps

* Keep debugging

* make_translation.py: fix formatting

* push.yml: try to set ENV values

* push.yml: fix copy-paste error

* Remove extra env var

* Experimenting

* Testing upper()

* Re-testing upper()

* Revert tested values

* make_translation.py: add new lines between blocks to improve readability

* Reformulate docs & comments

* make_translation.py: remove debugging print

* make_translation.py: simplify check for SHA ID env var / code review

* make_translation.py: fix condition

---------

Co-authored-by: Ben V. Brown <5425387+Ralim@users.noreply.github.com>
2023-08-04 21:54:29 +10:00
Ben V. Brown
584b3826c3 Start docs on BLE (#1763)
* docs on BLE

* Tip shorted notes
2023-08-01 02:39:29 +02:00
Ivan Zorin
1c9d3940ca Move related pieces of documentation from wiki to Documentation/ (#1746)
* Move TS100 info from wiki to Hardware.md

* Move TS80 info from wiki to Hardware.md

* Move TS80P info from wiki to Hardware.md

* Move Pinecil info from wiki to Hardware.md

* Move some info from Home.md wiki to Documentation/index.md

* Fix path inside docker since Dockerfile has been updated to be in the root project tree after starting container

* Move info from Home.md wiki to Documentation/Hardware.md

* mkdocs.yml: swtich config to forked repo for testing formatting online

* Fix formatting

* Fix formatting (md != rtd)

* Fix formatting for index.md

* Revert mkdocs config to original one after testing

* Documentation/: add power sources info

* Documentation/README.md: update with power sources

* tiny fixes with formatting

* Reformat links to stores

* Fix footnote on _default_ charger for TS80P

* Revert mkdocs config

* Fix footnote about wattage for QC, try fix table in index.md
2023-07-20 11:55:08 +10:00
Ivan Zorin
1d820acbee Documentation/index.md: add Feedback section (Ralim#1552) as suggested (#1744) 2023-07-18 14:35:16 +10:00
Ivan Zorin
4649df6914 Implement autogeneration of Documentation/README.md (#1738)
* mkdocs.yml: unify formatting style

* Docs/README.md: add auto-generated README.md file for Documentation/ directory

* Docs/README.md: fix refs

* Docs/README.md: fix locations

* Docs/README.md: trying workaround spaces in filenames for refs

* Documentation/README.md: update generated file trying to fix all formatting issues

* Documentation/README.md: reduce title size

* Documentation/README.md: add link for official online docs

* scripts/deploy.sh: implement docs_readme function

* deploy.sh: add overwrite warning in help output

* deploy.sh: try to fix shellcheck warnings

* deploy.sh:docs_readme() - show note message only if README should be updated

* deploy.sh:docs_readme() - fix shellcheck

* github/push: add Documentation/README.md check

* github/push: force usage of /bin/sh for deploy.sh script

* testing, testing, testing

* deploy.sh:docs_readme() - make error-related message more clear about what to donext

* Revert change used only to test failure on github CI
2023-07-11 09:36:05 +10:00
Ivan Zorin
cd7696b66f Suggestion to update BUILD_VERSION policy (#1733)
* version.h: update BUILD_VERSION policy / PoC

* Fix misplaced chars

* make_translation.py: implement get_version_suffix() function to extend BUILD_VERSION build type legend data

* version.h: update version policy info according to implementation of get_version_suffix() function in make_translation.py

* Version policy update: add double-check for release tag so if version doesn't match use another letter T

* make_translation.py: fix extra tabulation

* version.h: tiny tidy update for version format

* Documentation/DebugMenu.md: update info on version line & date

* Documentation/DebugMenu.md: fix formatting & mistypes

---------

Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-07-10 09:58:24 +10:00
Ivan Zorin
b524a99ff2 Root directory content refactoring (#1725)
* Root directory refactoring: - move info about Bootup Logo from a sepatate README to main README; - replace separate root scripts build.sh and start_dev.sh by root Makefile; - make Scripts directory and move there: flash_ts100_linux.sh script, ci/ directory, dockerfile, LICENSE_RELEASE, and PULL_REQUEST_TEMPLATE; - reconfigure build & deploy scripts according to changes

* Scripts => scripts

* Scripts -> scripts: re-add missing renamed files

* Directories refactoring: add top-level Makefile, add scripts/deploy.sh script, move github templates from top-level dir to .github, organize files inside Development Resources

* Update scripts/deploy.sh accroding to codestyle syntax shellcheck

* Makefile: add docs-deploy target for mkdocs gh-deploy

* Rename IronOS.yml > Env.yml, update related files

* Docs configs: remove empty characters

* docs/devel: update usage of new script
2023-07-02 11:32:40 +10:00
Laura
366b3356da Update Documentation/Menu.md
Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-04-25 19:11:06 +02:00
Laura
2745221643 Update Documentation/GettingStarted.md
Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-04-25 19:09:36 +02:00
discip
d94978f1ce Adjusted CJK and generalized some descriptions 2023-04-25 18:43:59 +02:00
Laura Klünder
578fd54463 soldering profile mode → profile mode 2023-04-25 11:56:57 +02:00
Laura Klünder
9559af39f7 add documentation for soldering profile mode 2023-04-25 11:56:57 +02:00
Vladimir
6177d4e2a4 Add building steps for Pinecil V2 to Development.md (#1634) 2023-03-24 13:19:52 +00:00
Adam Patridge
9247075458 Fix Markdown link typo 2023-03-20 11:30:26 -07:00
Adam Patridge
d834a3395c Update settings icon description 2023-03-20 11:23:24 -07:00
River M
344c1a649d Update documents, esp. Pinecil V2 instructions (#1604)
* Update README.md

* Update Pinecil V2.md

* Update Pinecil V2.md

update very outdated instructions on how to update Pinecil V2.

* Update Pinecil V1.md

* Update Pinecil V2.md

* Update Pinecil V2.md
2023-03-02 17:58:46 +11:00
Ben V. Brown
0b6c5ff837 👋 Goodbye Weblate
Dropping weblate for now as its just not reliable.
2023-01-30 17:26:41 +11:00
Ben V. Brown
05628daba2 Merge branch 'dev' into new-translations-format 2023-01-22 22:05:13 +11:00
discip
7fd7873b62 updated Menu.md (#1512)
Update Menu.md
2022-12-31 22:54:45 +11:00
Ben V. Brown
ec675da1d6 Update Translation.md 2022-12-07 18:37:40 +11:00
discip
8512da71ce solving issue #1423 2022-10-31 01:09:54 +01:00
discip
0199af1521 Update Settings.md 2022-10-27 17:53:27 +02:00
discip
7aa3b38696 cleared up some wording along with some typo fixes 2022-10-27 17:28:40 +02:00
Ben V. Brown
6fab3e5252 Generate a mkdocs github page + Migrate documentation links to use it (#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
2022-09-22 13:10:01 +10:00