[Dcoumentation] Define basic style for landing page #326
Labels
🎨 design
To be added in the Design System Management (DSM) Tool
📖 documentation
Improvements or additions to documentation
🧩 enhancement
Related to enhancements or feature requests
🙏 help wanted
Extra attention is needed
🔨 tool
Related to tooling
Context
Today our technical documentation is exposed through GitHub Pages and available at ios.unified-design-system.orange.com.
The content of the gh-pages is composed by assets of doccarchive folders exported using Xcode.
These elements are then processed so as to extract the assets we want, forge the final "web site" and create the landing page (#168).
The current script making such operation is this one. It copies and pastes HTML, CSS and JS files, and also merges some JSON.
These assets, picked from doccarchives files are in fact generated through documentation catalogs and DocC comments: thus the doc we have in our code is then reflected in a web fashion.
We export as many doccarchives as modules defined in our Swift Package.
Today, no Apple tool using the DocC documentation framework is able to output an HTML page pointing to all of these modules. Thus we use this script to forge an HTML file.
More details about the documentation toolchain avaialble in this wiki page.
Issue
That page is ugly, but it does the job:
But the page is ugly and not Orange branded.
Solution?
Use Boosted to customize the page to make it nicer, at least this the ODS web site
The script generating this main page must be keept as simple as possible. We can consider exracting the HTML code inside a side file, but we won't add more assets not framework.
The page can be found here
Attached: HTML page source
The text was updated successfully, but these errors were encountered: