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.

Sign up for GitHub

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

Jump to bottom

Doc/#1209 - #1250 - Add documentation page for each application and page template #1263

Open
wants to merge 18 commits into
base: develop
Choose a base branch
from
Open

Doc/#1209 - #1250 - Add documentation page for each application and page template #1263

wants to merge 18 commits into from

Conversation

trgiangdo
Copy link
Member

@trgiangdo trgiangdo commented Jan 22, 2025 •
edited
Loading

Resolves #1209
Resolves #1250

See temporary results on ReadTheDocs/doc-1209-application-templates.

@trgiangdo trgiangdo added 📈 Improvement Improvement of a feature. 📄 Documentation Internal or public documentation labels Jan 22, 2025
@trgiangdo trgiangdo self-assigned this Jan 22, 2025
FlorianJacta
FlorianJacta approved these changes Jan 22, 2025
View reviewed changes
Copy link
Member

@FlorianJacta FlorianJacta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

jrobinAV
jrobinAV reviewed Feb 3, 2025
View reviewed changes
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move the templates/ folder from docs/userman/ecosystem/ to docs/. I propose to expose the templates at the top level next to the tutorials. On the contrary, the cli/ folder remains unchanged, under docs/userman/ecosystem/ folder. Does it make sense?

I would also like to have a templates/index.md page that list all templates (for application and page).

What do you think?

@trgiangdo trgiangdo requested a review from jrobinAV February 5, 2025 09:23
jrobinAV
jrobinAV requested changes Feb 5, 2025
View reviewed changes
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions are not real suggestions but just a proposal for some new sections and new titles.

trgiangdo and others added 2 commits February 7, 2025 22:07
@trgiangdo @jrobinAV
Apply suggestions from code review
fd7a7fa 
Co-authored-by: Jean-Robin <jeanrobin.medori@avaiga.com>
@trgiangdo
feature: update the sdm template document with motivation, applicatio…
4c3098c 
…n description and customize the application sections
trgiangdo
trgiangdo commented Feb 8, 2025
View reviewed changes
Copy link
Member Author

@trgiangdo trgiangdo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the sdm.md file with the new structure.

@jrobinAV Please review this page.

When it's ok, I will restructure the default.md with similar structure.

@trgiangdo trgiangdo requested a review from jrobinAV February 8, 2025 10:38
jrobinAV
jrobinAV reviewed Feb 10, 2025
View reviewed changes
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly max line length

@trgiangdo @jrobinAV
Apply suggestions from code review
8710a17 
Co-authored-by: Jean-Robin <jeanrobin.medori@avaiga.com>
jrobinAV
jrobinAV reviewed Feb 12, 2025
View reviewed changes
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also add UI screenshots to make the doc appealing and to quickly explain the features available for an end-user.

@trgiangdo trgiangdo changed the title Doc/#1209 - Add documentation page for each application template Doc/#1209 - #1250 - Add documentation page for each application and page template Feb 17, 2025
jrobinAV
jrobinAV approved these changes Feb 17, 2025
View reviewed changes
@jrobinAV
Copy link
Member

I am getting 404 answers on the new templates chapter. I believe the folder name templates is not allowed by mkdocs. When I tried with tmplates, it worked like a charm.

jrobinAV
jrobinAV reviewed Feb 19, 2025
View reviewed changes
jrobinAV
jrobinAV reviewed Feb 19, 2025
View reviewed changes
jrobinAV
jrobinAV reviewed Feb 19, 2025
View reviewed changes
FabienLelaquais
FabienLelaquais requested changes Feb 19, 2025
View reviewed changes
Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure that " binding variable" does not appear.
It is confusing.

trgiangdo and others added 2 commits February 21, 2025 14:06
@trgiangdo @jrobinAV @FabienLelaquais
Apply suggestions from code review
355b0c0 
Co-authored-by: Jean-Robin <jeanrobin.medori@avaiga.com>
Co-authored-by: Fabien Lelaquais <86590727+FabienLelaquais@users.noreply.github.com>
@trgiangdo
fix: update doc convention and remove the use of binding variable word
160c72b
@trgiangdo trgiangdo linked an issue Feb 24, 2025 that may be closed by this pull request
Document the page templates #1250
Open
@trgiangdo trgiangdo added the ✨New feature A new feature is introduced. label Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrobinAV jrobinAV jrobinAV approved these changes

@FlorianJacta FlorianJacta FlorianJacta approved these changes

@FabienLelaquais FabienLelaquais Awaiting requested review from FabienLelaquais

Requested changes must be addressed to merge this pull request.

Assignees

@trgiangdo trgiangdo

Labels
📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. ✨New feature A new feature is introduced.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the page templates Add user manual documentation on templates
4 participants
@trgiangdo @jrobinAV @FabienLelaquais @FlorianJacta