{"id":27232873,"url":"https://github.com/nestordemeure/nersc_documentation_summarizer","last_synced_at":"2026-04-25T12:36:31.327Z","repository":{"id":284993886,"uuid":"956737478","full_name":"nestordemeure/nersc_documentation_summarizer","owner":"nestordemeure","description":"Boils the NERSC (mkdocs) documentation to a single markdown file for LLM ingestion.","archived":false,"fork":false,"pushed_at":"2025-03-28T21:56:23.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T14:24:14.329Z","etag":null,"topics":["documentation","llm","markdown"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nestordemeure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2025-03-28T19:16:15.000Z","updated_at":"2025-03-28T21:56:26.000Z","dependencies_parsed_at":"2025-03-28T20:28:08.354Z","dependency_job_id":"24f520af-fb10-4d02-ba96-f9a3b334a018","html_url":"https://github.com/nestordemeure/nersc_documentation_summarizer","commit_stats":null,"previous_names":["nestordemeure/nersc_documentation_summarizer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nestordemeure/nersc_documentation_summarizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestordemeure%2Fnersc_documentation_summarizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestordemeure%2Fnersc_documentation_summarizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestordemeure%2Fnersc_documentation_summarizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestordemeure%2Fnersc_documentation_summarizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nestordemeure","download_url":"https://codeload.github.com/nestordemeure/nersc_documentation_summarizer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestordemeure%2Fnersc_documentation_summarizer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32262801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T09:15:33.318Z","status":"ssl_error","status_checked_at":"2026-04-25T09:15:31.997Z","response_time":59,"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":["documentation","llm","markdown"],"created_at":"2025-04-10T14:10:18.074Z","updated_at":"2026-04-25T12:36:31.305Z","avatar_url":"https://github.com/nestordemeure.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NERSC's Documentation Summarizer\n\nBoils the [NERSC (mkdocs) documentation](https://gitlab.com/NERSC/nersc.gitlab.io/-/tree/main?ref_type=heads) to a single file for LLM ingestion, keeping only the most viewed pages.\n\n## Installing\n\nCreating a dedicated Python environment:\n\n```sh\n# Create a virtual environment\npython3 -m venv venv\n\n# Activate the virtual environment\nsource venv/bin/activate\n\n# Install dependencies\npip install pandas pyyaml\n```\n\n## Usage\n\nPlace the `Pages_and_screens_Page_title_and_screen_class.csv` file in an `inputs` folder.\n\nUpdate the NERSC documentation submodule:\n\n```sh\n# Pull the latest changes from the submodule's main branch\ngit submodule update --remote\n\n# Commit the updated submodule reference\ngit commit -m \"Update NERSC documentation submodule\"\n```\n\nLoad the Python environment and runing the code to collect the current documentation as a single file:\n\n```sh\nsource venv/bin/activate\n\npython3 merge.py\n```\n\n## Results\n\nCurrently (March 2025) the 248 files of our documentation seen at least once this month make for a 666296 Gemini tokens long file.\nFitting confortably in Gemini 2.5Pro's 1M tokens context length.\n\nShort tests show that Gemini 2.5Pro is able to answer questions meaningfully using the following prompt:\n\n```md\nYou have been given the [NERSC Supercomputing Center's documentation](https://docs.nersc.gov/). Use it to provide a NERSC-specific answer to questions submitted to you.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestordemeure%2Fnersc_documentation_summarizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnestordemeure%2Fnersc_documentation_summarizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestordemeure%2Fnersc_documentation_summarizer/lists"}