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] add various documentation improvements #680

Merged
merged 8 commits into from
Oct 1, 2020
Merged

[DOC] add various documentation improvements #680

merged 8 commits into from
Oct 1, 2020

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Oct 1, 2020 •
edited
Loading

Asciidoctor/html docs

  • review supported browser list
  • include favicon in html docs
  • add missing documentation about already supported start events for Event Sub-Process

Contributors

  • better asciidoctor file display on GitHub
  • BPMN support how-to: document how to credit the icons taken from external
    sources

covers #433

@tbouffard tbouffard marked this pull request as draft October 1, 2020 11:30
@tbouffard tbouffard force-pushed the doc/various_improvements_for_contributors branch from 023ac1e to b8937b5 Compare October 1, 2020 12:37
@tbouffard tbouffard force-pushed the doc/various_improvements_for_contributors branch from b8937b5 to ac83257 Compare October 1, 2020 12:57
@tbouffard tbouffard force-pushed the doc/various_improvements_for_contributors branch from ac83257 to 5e92414 Compare October 1, 2020 13:24
@tbouffard tbouffard changed the title [DOC] Improve documentation for contributors [DOC] add various documentation improvements Oct 1, 2020
@tbouffard tbouffard marked this pull request as ready for review October 1, 2020 13:28
@tbouffard tbouffard requested a review from csouchet October 1, 2020 13:28
csouchet
csouchet reviewed Oct 1, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
csouchet
csouchet reviewed Oct 1, 2020
View reviewed changes
docs/bpmn-support.adoc
@@ -188,7 +210,7 @@ The event definition can be defined on the event or on the definitions.
|icon:check-circle-o[]
|The icon width may be adjusted

|MessageNon-interrupting Start Event
|Message Non-interrupting Start Event
Copy link
Member

Choose a reason for hiding this comment

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

👍

csouchet
csouchet reviewed Oct 1, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
csouchet
csouchet reviewed Oct 1, 2020
View reviewed changes
docs/intro.adoc
Comment on lines +43 to +46
| icon:check[]
| icon:check[]
| icon:check[]
| icon:check[]
Copy link
Member

Choose a reason for hiding this comment

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

👍

csouchet
csouchet reviewed Oct 1, 2020
View reviewed changes
docs/intro.adoc Outdated Show resolved Hide resolved
csouchet
csouchet reviewed Oct 1, 2020
View reviewed changes
Copy link
Member

@csouchet csouchet left a comment

Choose a reason for hiding this comment

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

I just add some feedbacks to improve the modifications 😉

tbouffard and others added 2 commits October 1, 2020 16:18
@tbouffard @csouchet
Apply suggestions from code review
b197415 
browser support wording improvements

Co-authored-by: Souchet Céline <[email protected]>
@tbouffard
readme: use 'checked icon' in browser list
97745c3
@tbouffard tbouffard merged commit a6df58e into master Oct 1, 2020
@tbouffard tbouffard deleted the doc/various_improvements_for_contributors branch October 1, 2020 14:57
@tbouffard tbouffard added the documentation Improvements or additions to documentation label Oct 2, 2020
@csouchet csouchet added the hacktoberfest-accepted Accepted Pull Request during Hacktoberfest label Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@csouchet csouchet csouchet approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted Accepted Pull Request during Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tbouffard @csouchet