Skip to content

Docs FAQ update and cleanup #1519

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.

Sign up for GitHub

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

Merged
s3inlc merged 11 commits into from
Aug 20, 2025
Merged

Docs FAQ update and cleanup #1519

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4fc3425
removed leftover json file
s3inlc Aug 20, 2025
7e8b8f0
restored readme for mkdocs setup documentation
s3inlc Aug 20, 2025
c07b4d6
removed all uneccessary trailing spaces and newlines
s3inlc Aug 20, 2025
4eeded8
fixed consistency in volume/dir example and removed wrong line
s3inlc Aug 20, 2025
a1b11d8
updated all questions, adjusted styles and consistent listing, fixed …
s3inlc Aug 20, 2025
db5aa40
fixed changelog listing
s3inlc Aug 20, 2025
b376667
typo fix
s3inlc Aug 20, 2025
c01adc4
typo fix
s3inlc Aug 20, 2025
8f3f4c9
typo fix
s3inlc Aug 20, 2025
11dd21b
added gitignore and note regarding the openapi.json file
s3inlc Aug 20, 2025
ac1b7ce
removed commented note about documentation
s3inlc Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## MKDocs Local Setup

1. Make sure you are in the root of the server project and setup a virtual enviroment there.
2. Install mkdocs
3. Install required mkdocs extensions
4. Start the server
5. Browse to http://127.0.0.1:8000

``` bash
cd hashtopolis
virtualenv venv
source venv/bin/activate
pip3 install mkdocs
pip3 install $(mkdocs get-deps)
mkdocs server
```
1 change: 1 addition & 0 deletions doc/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
Release 0.14.3 comes with an update to the tech preview of the new API. Be aware, it is a preview, it contains bugs and it will change; To use it, please see https://github.com/hashtopolis/server/wiki/Installation.

Changes/Bugfixes on new UI:

- After updating a task, the tasks table is also updated
- Files can now be deleted via the context menu of the files-table
- Step sequence corrected according to agent registration
Expand Down
Loading