InditexTech / InditexTech/docouture
[OSO] Unified Documentation Framework for Inditex Tech
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 0
- Avg merge
- 3h 53m
- Merged PRs (30d)
- 93
Description
## 🎯 Objective
This initiative aims to align and standardize the documentation across all repositories of the public Inditex Tech GitHub organization, delivering a consistent, professional, and unified experience for the open source community.
Currently, documentation is fragmented and heterogeneous across repositories, with different structures, styles, and tooling. This makes it harder for external contributors and users to discover, navigate, and consume our projects.
Initial approach built on an [Antora](https://antora.org/), following the same proven model used internally in AMIGA Tech Docs, but delivered as a fully open source compliance solution.
## Scope
- Inventory and assessment of existing documentation across Inditex Tech repositories.
- Design and implementation of the shared open source solution.
- Migration guidelines and a pilot rollout on a set of reference repositories (Weave.js?).
## ✅ Success Criteria
- [x] Define a common documentation structure and style guide for all Inditex Tech repositories.
- [x] Provide a reusable, open source solution.
- [x] Automate documentation build and publishing via CI/CD ??
- [x] Lower the barrier for external contributions and improve the overall developer/community experience.
## 📌 Notes
Some examples of current docs:
- [API Scoring](https://inditextech.github.io/api-scoring-doc/)
- [Weave.js](https://inditextech.github.io/weavejs/)
- [Karate Tools](https://inditextech.github.io/karatetools-oss/karatetools-oss/latest/HOME/index.html)
Contributor guide
Assessment
This issue has not been assessed yet.