{"id":18916963,"url":"https://github.com/chainlit/literalai-docs","last_synced_at":"2026-03-09T17:13:47.680Z","repository":{"id":212693672,"uuid":"729041788","full_name":"Chainlit/literalai-docs","owner":"Chainlit","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-31T09:41:44.000Z","size":100706,"stargazers_count":3,"open_issues_count":1,"forks_count":9,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-15T11:49:43.785Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.literalai.com/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chainlit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-12-08T09:19:57.000Z","updated_at":"2025-03-31T09:41:47.000Z","dependencies_parsed_at":"2024-01-02T19:27:49.400Z","dependency_job_id":"0fe3faaa-4af5-4fe9-9199-17b82785cab8","html_url":"https://github.com/Chainlit/literalai-docs","commit_stats":null,"previous_names":["chainlit/platform-docs","chainlit/literal-docs","chainlit/literalai-docs"],"tags_count":0,"template":false,"template_full_name":"mintlify/starter","purl":"pkg:github/Chainlit/literalai-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fliteralai-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fliteralai-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fliteralai-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fliteralai-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chainlit","download_url":"https://codeload.github.com/Chainlit/literalai-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fliteralai-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30304036,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T14:33:48.460Z","status":"ssl_error","status_checked_at":"2026-03-09T14:33:48.027Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T10:23:09.202Z","updated_at":"2026-03-09T17:13:47.651Z","avatar_url":"https://github.com/Chainlit.png","language":"MDX","readme":"![Literal AI](/images/logoliteralai.png)\n\n# Literal AI Docs\n\n### Development\n\nInstall the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command\n\n```\nnpm i -g mintlify\n```\n\nRun the following command at the root of your documentation (where mint.json is)\n\n```\nmintlify dev\n```\n\nRun the following command to check broken links. \n\n```\nmintlify broken-links\n```\n\n### SDKs Documentation\n\u003e **⚠️ Warning:** Before proceeding, make sure to run `git pull` in both `sdk` folders to ensure you have the latest changes.\n\n#### Python SDK\n\nThe python SDK documentation is generated using ```generate-py-doc.sh``` script. The script uses the python docstrings to generate the documentation. The script relies on pydoc-markdown to generate the markdown files. The script can be run using the following arguments:\n- ```-s``` or ```--source-dir``` : The source directory where the python files are located. The default value is ```../literalai-python```.\n- ```o``` or ```--output-dir``` : The output directory where the markdown files will be generated. The default value is ```python-client/api-reference```.\n- ```b``` or ```--beautify``` : Uses some mintlify flags for a prettier result.\n- ```c``` or ```--config-file``` : The config file to be used for the generation. The default value is ```pydoc-markdown.yml```.\n\nThe script generates the markdown files in the output directory. The markdown files are then copied to the ```python-client/api-reference``` directory. Note that all the generated mdx files should be documented in the mint.json file.\n\n#### TypeScript SDK\n\nThe TypeScript SDK documentation is generated using ```generate-ts-doc.sh``` script. The script uses the TypeDoc to generate the documentation. The script can be run using the following arguments:\n- ```-s``` or ```--source-dir``` : The source directory where the TypeScript files are located. The default value is ```../literalai-typescript```.\n- ```o``` or ```--output-dir``` : The output directory where the markdown files will be generated. The default value is ```typescript-client/api-reference```.\n\nNote that this script only generates one file, ```README.md```, and do not dispose of much options at the moment. WIP !\n\n#### Run both\n\n`npm run doc`\n\n### Publishing Changes\n\nChanges will be deployed to production automatically after pushing to the default branch.\n\n#### Troubleshooting\n\n- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.\n- Page loads as a 404 - Make sure you are running in a folder with `mint.json`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchainlit%2Fliteralai-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchainlit%2Fliteralai-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchainlit%2Fliteralai-docs/lists"}