{"id":36734182,"url":"https://github.com/lambda-feedback/user-documentation","last_synced_at":"2026-01-12T12:17:03.266Z","repository":{"id":44558919,"uuid":"409936805","full_name":"lambda-feedback/user-documentation","owner":"lambda-feedback","description":"LambdaFeedback Teacher, Student and Developer Documentation (built using MkDocs)","archived":false,"fork":false,"pushed_at":"2025-12-19T08:17:21.000Z","size":70523,"stargazers_count":5,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-22T02:46:48.366Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://lambda-feedback.github.io/user-documentation/","language":null,"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/lambda-feedback.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-24T11:20:25.000Z","updated_at":"2025-12-19T08:16:47.000Z","dependencies_parsed_at":"2024-01-16T01:46:39.227Z","dependency_job_id":"55c2ed02-d12d-41e6-b8c2-ce85f05706ca","html_url":"https://github.com/lambda-feedback/user-documentation","commit_stats":null,"previous_names":["lambda-feedback/user_documentation","lambda-feedback/user-documentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lambda-feedback/user-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda-feedback%2Fuser-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda-feedback%2Fuser-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda-feedback%2Fuser-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda-feedback%2Fuser-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lambda-feedback","download_url":"https://codeload.github.com/lambda-feedback/user-documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda-feedback%2Fuser-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338975,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T10:58:46.209Z","status":"ssl_error","status_checked_at":"2026-01-12T10:58:42.742Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":"2026-01-12T12:17:03.196Z","updated_at":"2026-01-12T12:17:03.261Z","avatar_url":"https://github.com/lambda-feedback.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lambda Feedback User Documentation\n\nThis repository contains the user documentation for the Lambda Feedback platform. The documentation is built using [MkDocs](https://www.mkdocs.org/) and the [Material theme](https://squidfunk.github.io/mkdocs-material/) and is hosted on [GitHub Pages](https://lambda-feedback.github.io/user-documentation/).\n\n## Usage\n\nThis section guides you through the installation of the necessary dependencies and how to serve and build the documentation locally.\n\n### Pre-requisites\n\n- [Python 3.11](https://www.python.org/downloads/) or higher\n- [Poetry](https://python-poetry.org/docs/#installation)\n\n### Installation\n\nTo serve or build the documentation locally, you have to install its dependencies. The documentation mainly builds on the following libraries:\n\n- [MkDocs](https://www.mkdocs.org/getting-started/)\n- [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/getting-started/)\n- [EvalDocsLoader](https://github.com/lambda-feedback/EvalDocsLoader)\n\nTo install the dependencies using Poetry, run the following command:\n\n```bash\npoetry install\n```\n\n### Serving the Documentation\n\nTo serve the documentation locally, run the following command:\n\n```bash\npoetry run mkdocs serve\n```\n\nThis will start a local server at `http://127.0.0.1:8000/user-documentation/` where you can view the documentation.\n\n\u003e [!NOTE]\n\u003e You can ignore warnings or errors related to the EvalDocsLoader plugin, as long as you do not want to load external documentation pages for evaluation functions.\n\n### Building the Documentation\n\nTo build the documentation, run the following command:\n\n```bash\npoetry run mkdocs build\n```\n\nThis will build the documentation in the `site` directory.\n\n### Fetching Evaluation Function Documentation\n\nTo fetch the documentation for evaluation functions, the `EvalDocsLoader` plugin is used. The plugin is already installed as a dependency in the `pyproject.toml` file.\n\nWhen the necessary environment variables are set, the plugin will fetch the documentation for available evaluation functions automatically, and add them to the documentation.\n\nThe following environment variables are required:\n\n- `API_KEY`: The API key for the lambda feedback API.\n- `GITHUB_TOKEN`: A [GitHub Private Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with the `repo` scope to fetch the documentation from evaluation function repositories.\n\nTo set the environment variables, you can use the `export` command in your terminal:\n\n```bash\nexport API_KEY=\"\u003cyour-api-key\u003e\"\nexport GITHUB_TOKEN=\"\u003cyour-github-access-token\u003e\"\n```\n\nAfter setting the environment variables, you can serve or build the documentation as described above.\n\n## Deployment\n\nThe documentation is deployed to [GitHub Pages](https://pages.github.com/) using a GitHub Actions workflow. Deployment is done automatically after every commit to the `main` branch, as well as at midnight every day, UTC.\n\n## Documentation Development\n\nSome links you might find useful when authoring documentation content:\n\n- [MkDocs Documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-your-docs)\n- [MkDocs-Material Documentation](https://squidfunk.github.io/mkdocs-material/reference/)\n- [MkDocs Macros Plugin](https://mkdocs-macros-plugin.readthedocs.io/en/latest/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flambda-feedback%2Fuser-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flambda-feedback%2Fuser-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flambda-feedback%2Fuser-documentation/lists"}