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.

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

Write the docs #16

Open
edgardmarx opened this issue Jul 17, 2023 · 4 comments
Open

Write the docs #16

edgardmarx opened this issue Jul 17, 2023 · 4 comments
Assignees

Comments

@edgardmarx
Copy link
Contributor

edgardmarx commented Jul 17, 2023

This ticket consists in writing the docs for SANTé:

For reference, use: https://aksw.github.io/sante-api-docs

The documentation should be implemented at the repository: https://github.com/AKSW/sante-api-docs

The documentation should contain the following menu:

  • Introduction
  • Compiling
  • Creating an index
    • Docker
    • Jar
  • Running
    • sante.main
      • Docker
      • Jar
    • smile.smile
      • Docker
      • Jar
    • sante.api
      • Docker
      • Jar
  • APIs
    • DBpedia Lookup
    • Suggestion
    • Search
    • Reconcile
  • Known Issues & Limitations
@edgardmarx edgardmarx changed the title Write the API docs Write the docs Aug 7, 2023
@ronitblenz
Copy link
Collaborator

AKSW/sante-api-docs#1

PR Made, Kindly Check and close the ticket

@ronitblenz
Copy link
Collaborator

AKSW/sante-api-docs#2

Proposed Changes Made

@ronitblenz
Copy link
Collaborator

AKSW/sante-api-docs#3

Final Updated DOC

@ronitblenz
Copy link
Collaborator

AKSW/sante-api-docs#4

SANTe in 5 minutes

From JAR --> Docker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants