-
Notifications
You must be signed in to change notification settings - Fork 18
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.
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
fix(docs): DSP-API docs root route gives a 404 error (DEV-3345) #3073
fix(docs): DSP-API docs root route gives a 404 error (DEV-3345) #3073
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3073 +/- ##
===========================================
+ Coverage 11.74% 88.66% +76.92%
===========================================
Files 246 262 +16
Lines 22907 22480 -427
===========================================
+ Hits 2690 19932 +17242
+ Misses 20217 2548 -17669 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (non-blocking): Add a small table of contents to the overview
I feel like the current first page https://docs.dasch.swiss/latest/DSP-API/01-introduction/what-is-dsp/ gives a good overview/advertisement of the DSP platform.
Now that we have an actual "Overview" for just the api documentation it might be useful to point to some interesting starting point to dig deeper into the documentation.
Could be a bullet point list which is adding some information to the most interesting pages.
Something like:
Here are some interesting pages to get started:
* DSP Ontologies - An in depth description of data modelling
* DSP-API Endpoints - A user guide on how to interact with our platform with your own clients
* FAQ - Answers to common inquiries presented concisely for quick reference
praise: Thanks for swiftly solving this problem. |
Pull Request Checklist
Task Description/Number
For https://docs.dasch.swiss/latest/DSP-API/ (in our combined docs setup - in an isolated setup, this corresponds to the
/
route) to be available, MkDocs needs a top levelindex.md
file.Issue Number: DEV-3345
PR Type
Basic requirements for bug fixes and features
Does this PR introduce a breaking change?
Does this PR change client-test-data?