Commit Graph

3 Commits

Author SHA1 Message Date
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
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
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