Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Dcoumentation] Define basic style for landing page #326

Open
pylapp opened this issue Nov 29, 2024 · 3 comments
Open

[Dcoumentation] Define basic style for landing page #326

pylapp opened this issue Nov 29, 2024 · 3 comments
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

Comments

@pylapp
Copy link
Member

pylapp commented Nov 29, 2024

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:

  • it exposes hyperlinks pointing to all modules
  • the library version is displayed so as to notify the user the version of the doumentation lib he / she is reading
  • it refers also the GitHub project and the wiki
  • it contains the build number of the documentation

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

@pylapp pylapp added 📖 documentation Improvements or additions to documentation 🧩 enhancement Related to enhancements or feature requests 🎨 design To be added in the Design System Management (DSM) Tool 🔨 tool Related to tooling labels Nov 29, 2024
@pylapp pylapp moved this from Triage to Todo in [OUDS] Project Nov 29, 2024
@pylapp
Copy link
Member Author

pylapp commented Nov 29, 2024

Maybe @louismaximepiton or @julien-deramond know some tips or starter kits or the use of Boosted.

@hannahiss I may remember you have a quite similar need in your side.

@pylapp pylapp added the 🙏 help wanted Extra attention is needed label Nov 29, 2024
@louismaximepiton
Copy link
Member

Maybe we can wait for a common design landing page for web documentation and we will backport it in here once we have it. On the stack, if we want at least an header or footer, I'm afraid that we will need to have Boosted as a dependency for now. But let's wait for a design.

@hannahiss
Copy link
Member

hannahiss commented Dec 2, 2024

Yes I asked for a design for our homepage at least, but there has been 0 discussion about it so I'm not sure at all the need has been understood... Today Frederic assigned the issue to me in Jira 😦 ??!!
Issue is number 397 in our tracking tool
For the header/footer it will probably stay as is for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Status: Todo
Development

No branches or pull requests

3 participants