Skip to content

docs(frontend): simplify the doc for the non-power user - #876

Merged
bcm-at-zama merged 1 commit into
mainfrom
continue_doc_simplification
Jun 17, 2024
Merged

docs(frontend): simplify the doc for the non-power user#876
bcm-at-zama merged 1 commit into
mainfrom
continue_doc_simplification

Conversation

@bcm-at-zama

@bcm-at-zama bcm-at-zama commented Jun 11, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

@cla-bot cla-bot Bot added the cla-signed label Jun 11, 2024
@bcm-at-zama
bcm-at-zama marked this pull request as draft June 11, 2024 16:11
@bcm-at-zama
bcm-at-zama force-pushed the continue_doc_simplification branch 8 times, most recently from 26163f3 to 82cab47 Compare June 13, 2024 12:46
@bcm-at-zama

bcm-at-zama commented Jun 13, 2024

Copy link
Copy Markdown
Contributor Author

@BourgerieQuentin (and anyone interested): this is a proposal for simplifying a bit the doc for the users, to expose them mainly what is important. Could you tell me what you think about it? Once we've made your preferred changes, we can see with Yuxi for polishing, but let's agree first on the content.

@bcm-at-zama

bcm-at-zama commented Jun 14, 2024

Copy link
Copy Markdown
Contributor Author

I'll take #890 into account

@bcm-at-zama
bcm-at-zama force-pushed the continue_doc_simplification branch from 82cab47 to 5ef29e4 Compare June 14, 2024 13:42
@bcm-at-zama bcm-at-zama mentioned this pull request Jun 14, 2024
Merged
@bcm-at-zama
bcm-at-zama force-pushed the continue_doc_simplification branch 2 times, most recently from 0429c83 to d0518c1 Compare June 17, 2024 09:34
@bcm-at-zama
bcm-at-zama requested a review from aPere3 June 17, 2024 09:40
@bcm-at-zama

bcm-at-zama commented Jun 17, 2024

Copy link
Copy Markdown
Contributor Author

@aPere3 : I have changed a bit the composition+module doc, do you want to have a look (second commit)
And if you want to have a feedback on the full PR, I take it as well

@bcm-at-zama
bcm-at-zama marked this pull request as ready for review June 17, 2024 09:41
@bcm-at-zama bcm-at-zama changed the title docs(frontend): simplify the doc for the non-power user [WIP] docs(frontend): simplify the doc for the non-power user Jun 17, 2024
aPere3
aPere3 approved these changes Jun 17, 2024
View reviewed changes

@aPere3 aPere3 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me ! I made two propositions to rephrase things slightly. Thanks.

Comment thread docs/compilation/combining.md Outdated
Comment thread docs/compilation/composing_functions_with_modules.md Outdated
bcm-at-zama
bcm-at-zama commented Jun 17, 2024
View reviewed changes

@bcm-at-zama bcm-at-zama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed the issues seen by @aPere3

Comment thread docs/compilation/combining.md Outdated
Comment thread docs/compilation/composing_functions_with_modules.md Outdated
@bcm-at-zama

bcm-at-zama commented Jun 17, 2024

Copy link
Copy Markdown
Contributor Author

If fine with you @BourgerieQuentin , I would squash and merge

@bcm-at-zama
bcm-at-zama force-pushed the continue_doc_simplification branch from 3fc3320 to 96ab1b7 Compare June 17, 2024 15:20
@bcm-at-zama
bcm-at-zama merged commit 9fffe8b into main Jun 17, 2024
@bcm-at-zama
bcm-at-zama deleted the continue_doc_simplification branch June 17, 2024 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BourgerieQuentin BourgerieQuentin BourgerieQuentin approved these changes
@aPere3 aPere3 aPere3 approved these changes

Assignees

No one assigned

Labels

cla-signed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bcm-at-zama @BourgerieQuentin @aPere3