Skip to content

release: dev → main — publicar sitio de docs (sin bump de versión)#217

Merged
complexluise merged 4 commits into
mainfrom
dev
Jun 30, 2026
Merged

release: dev → main — publicar sitio de docs (sin bump de versión)#217
complexluise merged 4 commits into
mainfrom
dev

Conversation

@complexluise

Copy link
Copy Markdown
Owner

Qué libera

Lote solo-docs (no hay feat/fix, así que release-please no corta versión nueva — queda en v0.10.0). El objetivo es publicar el sitio en GitHub Pages: docs.yml se dispara al tocar main.

Tras el merge

docs.yml publica el sitio en Pages automáticamente. Back-merge main → dev para mantener las ramas en sintonía.

🤖 Generated with Claude Code

complexluise and others added 4 commits June 28, 2026 14:25
Declara qué es bib2graph y dónde se detiene a propósito: motor determinista, reproducible, con procedencia; no interpreta, no gestiona la investigación (no es Zotero/Mendeley) ni usa IA. Eleva la frontera a principio de diseño (funcionalidad muy distinta → otra herramienta, aunque sea parte del ciclo) y deja la nota lista para graduarse a ADR.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
chore: back-merge release v0.10.0 a dev
…ib2graph

docs(notas): 22 — frontera y alcance de bib2graph (nota de separación)
#215)

* docs: sitio MkDocs Material + deploy a GitHub Pages

Monta la capa de presentación para publicar la documentación como sitio,
reusando el contenido existente sin duplicarlo:

- mkdocs.yml: tema Material (es), nav por Diátaxis, search; reusa API.md,
  ARCHITECTURE.md, PRD.md y los 38 ADRs (docs/decisiones/). Excluye del sitio
  público lo interno (Notas/, _archivo/, features/, ROADMAP/).
- Landing (index.md) + getting-started (instalación, quickstart) nuevos.
- Páginas contributing/changelog/versioning/ai-disclosure que incluyen los .md
  de la raíz vía include-markdown (sin duplicar fuente).
- guias/index.md: marca el hueco de tutoriales/how-tos (Diátaxis) pendiente.
- .github/workflows/docs.yml: build con uv + deploy a GitHub Pages desde main.
- pyproject.toml: grupo de dependencias `docs` (PEP 735), no se publica a PyPI.

Build local verificado (mkdocs build, no-estricto). Quedan ~15 warnings de
enlaces relativos preexistentes a archivos fuera de docs/ (no fatales).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: referencia autogenerada (mkdocstrings + mkdocs-click), Diátaxis y Termynal

- Referencia de la librería autogenerada desde docstrings (mkdocstrings/griffe),
  agrupada por tema: docs/reference/python-api.md.
- Referencia del CLI b2g autogenerada desde el grupo Click (mkdocs-click):
  docs/reference/cli.md — siempre en sincronía con `b2g --help`.
- nav reestructurado en Diátaxis explícito: Empezar/Tutoriales (aprender),
  Guías (resolver), Referencia (consultar), Explicación (entender).
- Termynal anima la sesión seed→build→export del quickstart.
- Stubs de Tutoriales y Guías separados, ambos apuntando al #208.
- Deps en el grupo `docs`: mkdocstrings[python], mkdocs-click, termynal.

Build verificado con `uv run --with ... mkdocs build`: las tres autogeneraciones
producen contenido real (subcomandos del CLI, clases de la API, animación
Termynal). Warnings preexistentes de enlaces relativos y de indentación en
docstrings de openalex.py — no fatales.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: build de docs sin advertencias (validation + fix docstring)

Dos clases de warnings, dos fixes correctos:

- griffe (3): el docstring de `fetch_citing_*_with_works` en openalex.py usaba
  una lista con viñetas en Returns cuya indentación de continuación confundía al
  parser Google. Reformulado a prosa con indentación uniforme — solo texto, sin
  cambio de comportamiento.
- enlaces (~14): .md fuente (ADRs inmutables, archivos de raíz como
  CONTRIBUTING/VERSIONING/AGENTS) enlazan con rutas correctas en GitHub —su
  render principal— pero fuera de docs/ en el sitio. Se degradan a `info` vía
  `validation.links.not_found`, manteniendo `anchors: warn` para seguir cazando
  anclas rotas reales. No se editan los ADRs (inmutables) ni se rompe GitHub.

Build verificado: 0 warnings.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: sincronizar uv.lock con grupo docs + ignorar site/ y scratch/

El grupo `docs` (mkdocs-material y cía.) se agregó a pyproject.toml pero el
lockfile nunca se sincronizó — `uv sync --locked` en CI habría fallado.
`uv lock` lo regenera. Se ignoran `site/` (output de build, se publica vía
docs.yml) y `scratch/` (exploración local).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
@complexluise
complexluise merged commit 16e1b15 into main Jun 30, 2026
9 of 13 checks passed
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

Successfully merging this pull request may close these issues.

1 participant