From 91af57b9c2dfba5049d0031cabe1356fdb421d2b Mon Sep 17 00:00:00 2001 From: James C <5689414+james-cnz@users.noreply.github.com> Date: Wed, 15 May 2024 11:32:10 +1200 Subject: [PATCH] Remove docs from code, add links instead --- README.md | 52 ++++++++++---------------------------------- docs/contributing.md | 13 ----------- docs/roadmap.md | 23 -------------------- 3 files changed, 12 insertions(+), 76 deletions(-) delete mode 100644 docs/contributing.md delete mode 100644 docs/roadmap.md diff --git a/README.md b/README.md index cc1ca65..fa6034f 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,17 @@ -# Moodle Multitopic Format ⭐ +# Moodle Multitopic Format +Shows multiple topics per page, with tabbed navigation between pages. +Topics are collapsible, and can optionally be timed. +If you like the Multitopic format, and use the latest version, +please support the project by reporting any bugs you find. -> Shows multiple topics per page, with tabbed navigation between pages. Topics are collapsible, and can optionally be timed. +Developed at [Otago Polytechnic](https://www.op.ac.nz/) by James Calder. -### 🏠 [Otago Polytechnic](https://op.ac.nz) +## Links -## Install - -1. Copy files to moodle/course/format/multitopic. -2. Log in as an admin, and visit moodle/admin/index.php, to update plugin data. -3. (Moodle 3.x version only) Site administration > Appearance > Additional HTML > Within HEAD (or other location appropriate for CSS): Copy and paste styles from README_styles.css (customising appropriately). -4. Site administration > Appearance > Themes > Theme settings > Allow category themes: Yes (if you want categories to have custom CSS). - - -## Features - -* Tabbed pages (like Onetopic format) -* Multiple topics per page (a bit like Flexible Sections format) -* Collapsible topics (like Collapsed Topics format) -* Optionally timed topics (a bit like Periods format) -* Course banner image (like Snap theme) -* Section images (a bit like Grid format) - - -## Author - -👤 **James Calder** - -* Github: [@james-cnz](https://github.com/james-cnz) - - -## Docs - -🚀 [Roadmap](docs/roadmap.md) -📄 [Contributing](docs/contributing.md) - - -## Acknowledgements - -The Multitopic format is based on ideas from several other course formats, and notably includes code copied from: - -* Onetopic format by David Herney Bernal García (including code for displaying tabs, disabling asychronous editing, and managing settings) -* Periods format by Marina Glancy (code for managing settings) +* [Home page](https://moodle.org/plugins/format_multitopic) +* [Documentation](https://github.com/james-cnz/moodle-format_multitopic/wiki) +* [Source control](https://github.com/james-cnz/moodle-format_multitopic) +* [Bug tracker](https://github.com/james-cnz/moodle-format_multitopic/issues) +* [Discussion](https://moodle.org/mod/forum/discuss.php?d=394619) diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index 405dd7d..0000000 --- a/docs/contributing.md +++ /dev/null @@ -1,13 +0,0 @@ -# Multitopic: Contributing Guide ⭐ - - -### Style - -Please follow the [Coding Style on MoodleDocs](https://docs.moodle.org/dev/Coding_style) - - -### Submissions - -Submit a pull request onto the master branch. Keep your commits small and precise. - -Check out the [roadmap](roadmap.md) for things that need doing. \ No newline at end of file diff --git a/docs/roadmap.md b/docs/roadmap.md deleted file mode 100644 index 3028b81..0000000 --- a/docs/roadmap.md +++ /dev/null @@ -1,23 +0,0 @@ -# Multitopic: Roadmap ⭐ - - -### Known issues - -* Reorganising sections or moving activities doesn't change activity dates. -* Sections don't drag and drop immediately after non-AJAX move. - - -### Code - -* Improve comments. -* Write more unit tests. -* Prefer IDs over section numbers in AJAX. -* Standardise use of new lang_string() vs get_string(). -* Check use of section_info type annotations. -* Banner display vs banner preview, ensure consistent handling of non-image files. -* Update copyright notices (add "onwards"). - - -### UX/UI - -* Improve section image user experience.