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.

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

Jump to bottom

Create more thorough documentation #301

Closed
Kamforka opened this issue Oct 3, 2023 · 0 comments · Fixed by #350
Closed

Create more thorough documentation #301

Kamforka opened this issue Oct 3, 2023 · 0 comments · Fixed by #350
Assignees
@Kamforka
Labels
2.x category:enhancement

Comments

@Kamforka
Copy link
Collaborator

Kamforka commented Oct 3, 2023

Using mkdocs and leveraging existing type hints.
The docs should contain sections like:

  • introduction
  • requirements installation
  • quickstart
  • advanced examples for selected enpoints like: alerts, cases, observables, tasks, cortex, organisations, user management
  • API docs
@Kamforka Kamforka self-assigned this Oct 3, 2023
@Kamforka Kamforka mentioned this issue Oct 3, 2023
Closed
5 tasks
Kamforka added a commit that referenced this issue Oct 6, 2023
@Kamforka
#301 - Change to MIT license
9171fec
@Kamforka Kamforka mentioned this issue May 17, 2024
Closed
Kamforka added a commit that referenced this issue Oct 7, 2024
@Kamforka
#301 - Add client, alert and api reference docs
67cf7cf
@Kamforka Kamforka linked a pull request Oct 7, 2024 that will close this issue
#301 - Add client, alert and api reference docs #350
Merged
@Kamforka Kamforka mentioned this issue Oct 7, 2024
Merged
Kamforka added a commit that referenced this issue Oct 17, 2024
@Kamforka
#301 - Add client, alert and api reference docs
fce7284
Kamforka added a commit that referenced this issue Oct 17, 2024
@Kamforka
#301 - Add client, alert and api reference docs
a8ca401
Kamforka added a commit that referenced this issue Oct 17, 2024
@Kamforka
#301 - Add client, alert and api reference docs
8934699
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
9f4f670
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
bfbec19
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
689c14d
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
9ef5a93
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
bfe1fa6
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
61d3b5d
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Add client, alert and api reference docs
201d7d9
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
Merge pull request #350 from TheHive-Project/301-create-more-thorough…
ab5e10a 
…-documentation

#301 - Add client, alert and api reference docs
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Adjust thehive4py title's font size
42ce8e6
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Adjust thehive4py title's font size
74b5de3
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Adjust thehive4py title's font size
1d2d500
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
#301 - Adjust thehive4py title's font size
3ef7cc4
Kamforka added a commit that referenced this issue Oct 18, 2024
@Kamforka
Merge pull request #357 from TheHive-Project/301-create-more-thorough…
7cd0836 
…-documentation

#301 - Adjust thehive4py title's font size
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kamforka Kamforka

Labels
2.x category:enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#301 - Add client, alert and api reference docs TheHive-Project/TheHive4py
1 participant
@Kamforka