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

[Documentation] [Study] Alpha build of documentation #353

Open
3 tasks
pylapp opened this issue Dec 17, 2024 · 0 comments
Open
3 tasks

[Documentation] [Study] Alpha build of documentation #353

pylapp opened this issue Dec 17, 2024 · 0 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation 🙏 help wanted Extra attention is needed 🔍 study Topic shuld be studied with prototypes or prooves of concepts 🔨 tool Related to tooling

Comments

@pylapp
Copy link
Member

pylapp commented Dec 17, 2024

Context

Some features can be alpha-tested, like for example components and modules.
These features must be documented, i.e. have their Swift file updated and mauybe the DocC catalogs.
The documentation process is not 100%-automatized: we need to use Xcode manualy to build the doccarchive, then run the script to build the HTML doc.
It can be interesting to have a preview of the HTML documentation for the PO for example. We can imagine to use Netlify to load HTML content in a docs folder in the feature branch. This docs folder will be populated by the documentation script but without updating the GitHub Pages branch.

For example, using the command:

uploadWebDoc.sh --libversion=\#XXX 
# Do not add --usegit option so as to not update the GitHub branch
# Replace libversion value by for example the issue number

Definition of Ready

  • Check of works Netlify
  • Check if possible to provide documentation on a feature branch in a dedicated folder
  • Chekc if the doc script can be updated to as to copy the THML assets from temporary folder to another one
@pylapp pylapp added 📖 documentation Improvements or additions to documentation 🔍 study Topic shuld be studied with prototypes or prooves of concepts 🔨 tool Related to tooling 🙏 help wanted Extra attention is needed labels Dec 17, 2024
@pylapp pylapp self-assigned this Dec 17, 2024
@pylapp pylapp moved this from Triage to Todo in [OUDS] Project Dec 17, 2024
@pylapp pylapp moved this from Todo to Triage in [OUDS] Project Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation 🙏 help wanted Extra attention is needed 🔍 study Topic shuld be studied with prototypes or prooves of concepts 🔨 tool Related to tooling
Projects
Status: Triage
Development

No branches or pull requests

1 participant