Agents Docs Index
Agents Docs Index
This directory contains spec templates and process guides for bot-assisted and human-assisted changes in this repository.
Recommended Reading Order
-
AGENTS.md
Purpose: repository-wide operating policy for bots. -
agents/INDEX.md
Purpose: map of available specs/templates and when to use them. -
Task-specific templates below
Purpose: apply the right schema/checklist for the requested work.
Specs and Templates
Architecture and data flow
-
agents/SITE_ARCHITECTURE_SPEC_TEMPLATE.md
Use when documenting or planning structural/site-wide changes, including local preview/build runbook details. -
agents/IMPACT_DATA_PIPELINE_SPEC_TEMPLATE.md
Use when planning updates to impact metrics inputs (_data/scholar_metrics.json,_data/map_data.json) and related scripts/workflows. -
agents/IMPACT_DASHBOARD_PIPELINE_SPEC.md
Use for the/impact/dashboard pipeline (_publications+ scholar/map + altmetric raw -> generated JSON/CSV -> include-based page embed -> local/deploy build hooks). -
agents/CAREER_FOOTPRINT_PIPELINE_SPEC.md
Use for the/background/career footprint map pipeline (_newsgeo front matter -> generated JSON -> page embed -> Actions deploy).
Content models
-
agents/PUBLICATIONS_SPEC_TEMPLATE.md
Use for publication entry schema and compatibility expectations. -
agents/PUBLICATIONS_TAGS_SPEC.md
Use for canonical publication tag taxonomy andtypevstagsusage rules. -
agents/PUBLICATIONS_INTERDISCIPLINARITY_BRAID_SPEC.md
Use for the/publications/interdisciplinarity braid panel (theme-group -> method-family -> scale flow visualization). -
agents/NEWS_SPEC_TEMPLATE.md
Use for_newsitem structure and excerpt conventions. -
agents/RESEARCH_SPEC_TEMPLATE.md
Use for_researchentry schema and ordering/card conventions. -
agents/RESEARCH_METHOD_TAGS_DATA_SPEC.md
Use for canonical method-family/tag schema in_data/research_method_tags.yml, including portfolio paper linkage mappings. -
agents/RESEARCH_METHOD_EXPLORER_SPEC.md
Use when revisiting the deferred advanced methods explorer UI for/research/. -
agents/TALKS_DATA_SPEC_TEMPLATE.md
Use for_data/talks.ymlschema used by the talks page. -
agents/PAGES_SPEC_TEMPLATE.md
Use for_pagesschema and page-level front matter/body conventions.
Process and quality
-
agents/WORKFLOWS_SPEC_TEMPLATE.md
Use to plan workflow changes before touching.github/workflows/*(explicit request required). -
agents/CHANGE_REQUEST_TEMPLATE.md
Use to define precise task requests for bots (scope, constraints, acceptance criteria, git preferences). -
agents/REVIEW_CHECKLIST.md
Use before handoff/merge to verify scope, policy, and quality requirements.
Maintenance
- If you add, rename, or remove files in
agents/, update this index in the same change. - Keep links relative so they work for all collaborators and in GitHub UI previews.