Conversation
danalvrz
left a comment
danalvrz
left a comment
There was a problem hiding this comment.
In general it looks great, but we need to take a final look at the content details. I added a few comments on things I noticed, but probably needs additional review. It would be great to get approval from people behind the implementation of the features.
danalvrz
left a comment
danalvrz
left a comment
There was a problem hiding this comment.
looks good to me, only a couple comments left. Let's wait for approval from @kitconcept/documentation before merging.
There was a problem hiding this comment.
We might want to find another place for this instructions file, since it can be useful in other projects too. I would not keep it here after development is done.
davisagli
left a comment
davisagli
left a comment
There was a problem hiding this comment.
I reviewed the developer docs but didn't have time for the others yet. In general, there are some problems where it is hallucinating components that don't exist. I would expect you should review the output of the agent carefully enough to catch this sort of thing before submitting it for review. (But no big problem, I realize we're catching up and it will be easier going forward when each PR updates docs for the code it's changing.)
|
@iFlameing, if you are using AI to generate any code or documentation, you are fully responsible for the code in that PR. It is your responsibility to ensure there are no hallucinations in there. We do not force anyone to use AI at kitconcept. However, if you do, you should be in control and responsible. We want to scale our team and grow our team mates, making generating code easier (with AI) and putting more effort on the seniors who review is the opposite direction we want to go. cc @danalvrz @davisagli @ericof @sneridagh @fredvd This is a general remark on AI and not restricted to this PR. |
|
@tisto Thanks for the clarification. This was our first experiment working with LLM generated documentation and I pushed to review too early assuming it could be refined during the process. I overlooked potential hallucinations on my side. I fully agree that the code and documentation are my responsibility and should meet our standards, and I will keep this in mind for future implementations. |
|
@iFlameing, no worries. We are all learning how to deal with those new possibilities. I just wanted to make this clear in general. |
davisagli
left a comment
davisagli
left a comment
There was a problem hiding this comment.
@iFlameing Thanks for the updates, the developer docs look much better now.
davisagli
left a comment
davisagli
left a comment
There was a problem hiding this comment.
I did a quick skim through the end user docs and they look pretty good. It would be nice to have one of our junior colleagues do QA to make sure the instructions are accurate. But in general I'm ok with merging this soon and making incremental fixes later.
|
|
||
| ## Overview | ||
|
|
||
| The kitconcept Intranet provides a rich set of content blocks for building pages. In addition to the standard Volto blocks, the following custom blocks are available: |
There was a problem hiding this comment.
It would be nice to improve this in the future to include the standard blocks (actually they are a mix of Volto core and other block add-ons supported by VLT). But this is perfect for now.
davisagli
left a comment
davisagli
left a comment
There was a problem hiding this comment.
@iFlameing Thanks for all your work on this. I think we should merge it now.
danalvrz
left a comment
danalvrz
left a comment
There was a problem hiding this comment.
@iFlameing I added comments on a few things I found, please take a look. I would be ok with merging as is, as long as we keep track of the needed updates. Also https://github.com/kitconcept/kitconcept.intranet/pull/362/changes#r3203378046
|
|
||
| | Field | Description | | ||
| |-------|-------------| | ||
| | **Title** | Headline text for the slide | |
There was a problem hiding this comment.
| | Field | Description | | |
| |-------|-------------| | |
| | **Title** | Headline text for the slide | | |
| | Field | Description | | |
| |-------|-------------| | |
| | **Target** | Content item the slide references and links to| | |
| | **Title** | Headline text for the slide | |
| Submissions are sent by email. Configure the recipient in the **Email** tab of the sidebar: | ||
|
|
||
| | Field | Description | | ||
| |-------|-------------| | ||
| | **Send to** | The email address that receives submissions. Can be a single address or a comma-separated list. | | ||
| | **Reply-to field** | Select a form field (typically an Email field) to use as the reply-to address | | ||
| | **Subject** | Email subject line. You can include field values using `{field_id}` placeholders. | | ||
| | **Message template** | Optional template text added before the submitted values | |
There was a problem hiding this comment.
This fields don't match what I see when I am looking at the Form block sidebar. And the docs mention a Email tab, which I can't find.
| Use a shared mailbox (e.g. `helpdesk@example.com`) rather than a personal address so submissions are not lost if someone leaves the organisation. | ||
| ::: | ||
|
|
||
| ### Adding Fields |
There was a problem hiding this comment.
The docs don't mention the feature of having multiple fieldsets tabs, which I think would be important to include.
4 participants
No description provided.