Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
518 commits
Select commit Hold shift + click to select a range
31bd296
Merge pull request #3481 from spryker/ai-dev-sdk-docs
alex-galych Feb 17, 2026
fad07ab
remove incomplete section (#3457)
profuel Feb 17, 2026
b650f93
ai-dev-change-to-ai-dev-sdk
alex-galych Feb 17, 2026
5522f8b
Merge pull request #3486 from spryker/ai-dev-change-to-ai-dev-sdk
alex-galych Feb 17, 2026
b5ac8df
FE-namespace: Update Development Guide to include FE namespace config…
vitaliiivanovspryker Feb 17, 2026
156b253
Merge pull request #3487 from spryker/add-FE-namespace-resolve
vitaliiivanovspryker Feb 17, 2026
93dd3c4
Update
vol4onok Feb 17, 2026
4b4273f
Merge branch 'master' of github.com:spryker/spryker-docs into feature…
vol4onok Feb 17, 2026
05af191
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
fc69dba
CC-36581 product availability display feature (#3480)
geronica Feb 17, 2026
275db68
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
e1c6e4f
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
b178e1c
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
5838639
AI-WORKFLOW: Add documentation for AI workflow orchestration with sta…
vitaliiivanovspryker Feb 18, 2026
e1ac0ee
Merge pull request #3488 from spryker/feature/frw-11575/master-fix-re…
vol4onok Feb 18, 2026
c4a5e76
AI-47: Update AI Dev Guide sidebar and improve workflow orchestration…
vitaliiivanovspryker Feb 18, 2026
ffbb8f4
AI-WORKFLOW: Add AI workflow orchestration links to documentation for…
vitaliiivanovspryker Feb 18, 2026
9c8bc3b
AI-WORKFLOW: Extend documentation with workflow triggering steps for …
vitaliiivanovspryker Feb 18, 2026
9a8db3e
CC-36581: Update Composer requirements for buy box and product availa…
abitskil Feb 18, 2026
4d577b1
improve CI to validate last_updated
profuel Dec 8, 2025
589cbdf
improve CI to validate last_updated
profuel Dec 8, 2025
a719f04
improve CI to validate last_updated
profuel Dec 8, 2025
d110eea
improve CI to validate last_updated
profuel Dec 8, 2025
80d6b62
improve CI to validate last_updated
profuel Dec 8, 2025
8feacb1
improve CI to validate last_updated
profuel Dec 8, 2025
9da889b
improve CI to validate last_updated
profuel Dec 8, 2025
abe2639
improve CI to validate last_updated
profuel Dec 8, 2025
e111d7d
improve CI to validate last_updated
profuel Dec 8, 2025
51c1c56
introduce version id
profuel Jan 28, 2026
2e4e453
Patching faq
michalwroblewski-spryker Feb 18, 2026
37cf9fd
testing files changed
profuel Feb 18, 2026
7e2ec83
Replaced version with versionid
olhalivitchuk Feb 18, 2026
3f47259
Update API-Platform documentation to remove CodeBucket warning
demkos Feb 18, 2026
6fcbe27
testing faster git fetch
profuel Feb 19, 2026
e6ab7d0
testing faster git fetch
profuel Feb 19, 2026
caa1fda
Merge pull request #3385 from spryker/test/ci-improvement
profuel Feb 19, 2026
1db0cc7
Patching faq
michalwroblewski-spryker Feb 18, 2026
d08f57b
Merge branch 'master' into ai-workflow
vitaliiivanovspryker Feb 19, 2026
16cb8d6
AI-WORKFLOW: Update documentation workflow and validation guidelines,…
vitaliiivanovspryker Feb 19, 2026
cfa733f
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
1bec0b6
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
28d4f3f
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
0b9fc3a
Symfony scheduler and messenger docs
gechetspr Feb 17, 2026
5970655
failing check
michalwroblewski-spryker Feb 19, 2026
8a44fdf
Update CLAUDE.md
vitaliiivanovspryker Feb 19, 2026
2741332
Merge branch 'patching_faq' of https://github.com/spryker/spryker-doc…
michalwroblewski-spryker Feb 19, 2026
fdcf376
Added new var for release tag, replaced everywhere, fixed links to ar…
olhalivitchuk Feb 19, 2026
6670be8
Merge branch 'master' of github.com:spryker/spryker-docs into version…
olhalivitchuk Feb 19, 2026
ae12336
Fixed CI
olhalivitchuk Feb 19, 2026
b5d35b9
Fixed Last Updated date
olhalivitchuk Feb 19, 2026
c8de8b8
SUPESC-1077: update integration guide for twig cache warmer
annakotiuk Feb 19, 2026
d62e7a2
updates from Oleg
michalwroblewski-spryker Feb 19, 2026
c3839cd
SUPESC-1077: CR fixes
annakotiuk Feb 19, 2026
c1faeb7
Merge pull request #3491 from spryker/ai-workflow
spryker-release-bot Feb 19, 2026
cb6354d
Merge pull request #3496 from spryker/bugfix/supesc-1077/master-fix-t…
annakotiuk Feb 19, 2026
42c44f5
CC-37087: New Algolia Eco integration (#3489)
matweew Feb 19, 2026
d594a70
erp integration template
profuel Feb 12, 2026
609a1eb
Update erp-integration-template.md
profuel Feb 12, 2026
d3b43ac
rename some->example
profuel Feb 16, 2026
e8a62d1
Update erp-integration-template.md
profuel Feb 16, 2026
a4b887e
fixed grammar and comments
profuel Feb 19, 2026
002994a
Merge pull request #3477 from spryker/erp-integration-template
profuel Feb 19, 2026
7bddb4c
dev plan for punchout
profuel Feb 16, 2026
e7a72c6
Fixes after valudation
profuel Feb 17, 2026
4b3b8e6
Update punchout-development-plan.md
profuel Feb 17, 2026
8805f2b
fixed formatting and review suggestions
profuel Feb 17, 2026
858d4e3
fix link
profuel Feb 17, 2026
d778cfa
fixed grammar and comments
profuel Feb 19, 2026
159e4a8
Merge pull request #3485 from spryker/punchout
profuel Feb 20, 2026
914bbf7
Merge pull request #3494 from spryker/patching_faq
michalwroblewski-spryker Feb 20, 2026
c81d667
Fixed conflicts
olhalivitchuk Feb 20, 2026
c222aad
Merge pull request #3493 from spryker/versionid-parameter
profuel Feb 20, 2026
abf62fb
Document ResourceAwareQueueWorker and consolidate Jenkins optimizatio…
ishakuta Feb 20, 2026
7ec6733
Merge branch 'master' into docs/resource-aware-queue-worker
ishakuta Feb 20, 2026
5edd6dd
Added warning message
olhalivitchuk Feb 20, 2026
2b82c1e
Merge pull request #3502 from spryker/added-beta-warning-message-for-…
profuel Feb 20, 2026
a2d5701
improve documentation
vitaliiShveider Feb 20, 2026
a7a219a
Merge branch 'master' of github.com:spryker/spryker-docs into feature…
vitaliiShveider Feb 20, 2026
8f8c4f1
FRW-11589 Updated Compile the Container section.
stereomon Feb 23, 2026
3c14e0a
FRW-11589 Fixed updated at date.
stereomon Feb 23, 2026
a684656
SOL-478 Payment template doc.
limeeugenia Feb 23, 2026
a6ad486
SOL-478 added navigation, renamed.
limeeugenia Feb 23, 2026
292e3da
rework navigation
profuel Feb 20, 2026
457291d
rework navigation, fix titles, add keywords
profuel Feb 20, 2026
c296ced
Merge pull request #3500 from spryker/fix-integration-links
profuel Feb 23, 2026
4eb163c
SOL-478 DocGPT fixes.
limeeugenia Feb 23, 2026
e37b484
Merge pull request #3503 from spryker/feature/frw-11095/frw-11589-upd…
profuel Feb 23, 2026
9c1fb9b
Merge remote-tracking branch 'origin/master' into feature/sol-478-eco…
limeeugenia Feb 23, 2026
bfecbc0
SOL-478 Added buzzwords.
limeeugenia Feb 23, 2026
283e39c
SOL-478 Opus fixes, section on the custom integrations page.
limeeugenia Feb 23, 2026
24922c4
SOL-478 Docu CI fixes.
limeeugenia Feb 23, 2026
94a0fb0
Address PR review: bold intro sentence, remove -vvv flag
ishakuta Feb 23, 2026
042997c
Apply suggestions from code review
ishakuta Feb 23, 2026
5e57884
Apply suggestions from code review
ishakuta Feb 23, 2026
e782310
Merge pull request #3501 from spryker/docs/resource-aware-queue-worker
ishakuta Feb 23, 2026
69bcdc8
Address remaining PR #3501 review comments
ishakuta Feb 23, 2026
3c388a1
Update CI documentation with testing guidelines and additional refere…
vitaliiivanovspryker Feb 24, 2026
b8330d5
INITITAL-CI-CONFIG: Update CI documentation to enhance clarity and ad…
vitaliiivanovspryker Feb 24, 2026
8c24e34
FIX-CLAUDE-RULE-PATHS: Update CI documentation with corrected links, …
vitaliiivanovspryker Feb 24, 2026
f1a3c1e
Merge pull request #3510 from spryker/initital-ci-config
vitaliiivanovspryker Feb 24, 2026
c8caaae
Merge pull request #3506 from spryker/docs/resource-aware-queue-worke…
ishakuta Feb 24, 2026
011bfdf
update version of the documentation
pyvovarov-s Feb 23, 2026
fe30a4d
Remove version '202602.0' from _config.yml
pyvovarov-s Feb 24, 2026
0f10026
Elaborate RabbitMQ queue adapter prerequisite with verification steps
ishakuta Feb 24, 2026
c95d63f
Merge pull request #3511 from spryker/docs/elaborate-rabbitmq-prerequ…
ishakuta Feb 24, 2026
33ce02c
Merge branch 'master' into feature/sol-478-eco-payment-module-template
ishakuta Feb 24, 2026
69fdc39
Merge pull request #3504 from spryker/feature/sol-478-eco-payment-mod…
ishakuta Feb 24, 2026
661138d
Added a section about architecture as code
feversocial Feb 19, 2026
2982bbf
Fixed pipeline issues, updated documentation
feversocial Feb 20, 2026
9f94a90
Fixed pipeline issues, updated documentation
feversocial Feb 20, 2026
9ccb9d1
Update docs/dg/dev/architecture/architecture-as-code.md
feversocial Feb 23, 2026
06be84a
Update docs/dg/dev/architecture/architecture-as-code.md
feversocial Feb 23, 2026
33b49fb
Update architecture-as-code.md
feversocial Feb 24, 2026
87e8e6c
fixed dashes
profuel Feb 24, 2026
74a33d2
Merge pull request #3499 from spryker/feature/SOL-464-architecture-as…
profuel Feb 24, 2026
4e9af3a
Starter point.
vlunov-spryker Feb 24, 2026
1945cb2
Merge branch 'master' into web-profiler-propel
vitaliiivanovspryker Feb 24, 2026
59c4a03
FRW-11267: Update Web Profiler documentation links and `last_updated`…
vitaliiivanovspryker Feb 24, 2026
b9aa9ad
Merge pull request #3495 from spryker/removed-codebucket-usage
demkos Feb 24, 2026
21c520a
[CC-37167]: Product Attachments (#3505)
vitaliiShveider Feb 24, 2026
d6bb8b7
Release notes.
vlunov-spryker Feb 24, 2026
3fcd5f2
Release notes.
vlunov-spryker Feb 24, 2026
46b466a
Release notes.
vlunov-spryker Feb 24, 2026
0470e25
Merge branch 'master' into release-202602
vlunov-spryker Feb 24, 2026
b16bee1
FRW-11461 Document API Platform relationship system. (#3468)
stereomon Feb 25, 2026
c61770b
Release notes.
vlunov-spryker Feb 25, 2026
0c35e32
Merge branch 'release-202602-dx' into release-202602
vlunov-spryker Feb 25, 2026
d95bfff
Add commerce and AI release notes
amansilla Feb 25, 2026
7e51d5f
Revert fixing not related file
profuel Feb 25, 2026
786574e
Extend AI release notes
amansilla Feb 25, 2026
4b39e16
Extend AI release notes
amansilla Feb 25, 2026
8334e5e
Add doc links
amansilla Feb 25, 2026
4a65f60
Extend commerce release notes
amansilla Feb 25, 2026
d97a897
Extend commerce release notes
amansilla Feb 25, 2026
40b4720
Remove bugfixes from release notes as agreed
amansilla Feb 25, 2026
61b518e
Release notes.
vlunov-spryker Feb 25, 2026
a3c4c1f
Merge branch 'release-202602' into release-202602-dx
vlunov-spryker Feb 25, 2026
3966462
Merge branch 'master' into release-202602-dx
vlunov-spryker Feb 25, 2026
96e7cdb
Release notes.
vlunov-spryker Feb 25, 2026
d600218
Release notes.
vlunov-spryker Feb 25, 2026
e3705a2
Release notes.
vlunov-spryker Feb 25, 2026
e46726a
Release notes.
vlunov-spryker Feb 25, 2026
b628c27
Revise release notes for version 202602.0
chepur Feb 25, 2026
964635e
Rework release UX item
amansilla Feb 25, 2026
80939b3
Revise release notes for version 202602.0
chepur Feb 25, 2026
7b9f741
Revise release notes for clarity and consistency.
chepur Feb 25, 2026
28d33f7
Update app-composition-platform.md
viclarspry Feb 25, 2026
1ec0bdc
Merge pull request #3507 from spryker/product-release-202602.0
pyvovarov-s Feb 25, 2026
2074c93
Add links
amansilla Feb 25, 2026
f47bb2b
Extend Smart PIM docs with new features
amansilla Feb 25, 2026
472ecc5
app-composition-platform.md
viclarspry Feb 25, 2026
56bb4c6
Release notes.
vlunov-spryker Feb 25, 2026
952dacf
Merge pull request #3516 from spryker/viclarspry-patch-1
amansilla Feb 25, 2026
d67d257
Merge branch 'release-202602-dx' into release-202602
vlunov-spryker Feb 25, 2026
f7b6b61
Merge branch 'master' into release-202602
vlunov-spryker Feb 25, 2026
34a3d0a
Update release-notes-202602.0.md
viclarspry Feb 25, 2026
06391cc
Merge branch 'release-202602' into viclarspry-patch-2
viclarspry Feb 25, 2026
46c68da
Merge pull request #3518 from spryker/viclarspry-patch-2
viclarspry Feb 25, 2026
b11620e
Release notes.
vlunov-spryker Feb 25, 2026
ac2202c
Release notes.
vlunov-spryker Feb 25, 2026
bb0c689
fixed link name
profuel Feb 26, 2026
b3163eb
Fix wrong styling
profuel Feb 26, 2026
5cc78e4
Merge pull request #3517 from spryker/update_smart_pim
amansilla Feb 26, 2026
2f0efd5
Merge branch 'master' of https://github.com/spryker/spryker-docs into…
amansilla Feb 26, 2026
671e96d
Add backoffice configuration framework business docs
amansilla Feb 23, 2026
315679a
Fix missing links
amansilla Feb 26, 2026
3fc84c2
Apply doc genius suggestions
amansilla Feb 26, 2026
ab00ae7
Add minor improvement
amansilla Feb 26, 2026
d042322
Add carousel
amansilla Feb 26, 2026
a516164
Updated scheduler and messenger docs
gechetspr Feb 26, 2026
9ec6bc6
Updated scheduler and messenger docs
gechetspr Feb 26, 2026
b15c38c
Updated scheduler and messenger docs
gechetspr Feb 26, 2026
ae8d517
Added compilation from RabbitMq vars
gechetspr Feb 26, 2026
fd0c8d1
File names for locatable classes
gechetspr Feb 26, 2026
bb5fca4
Add labels
amansilla Feb 26, 2026
5aa2493
Merge pull request #3490 from spryker/frw-11296-symfony-messenger-sch…
gechetspr Feb 26, 2026
3ae92ec
Merge branch 'master' into release-202602
vlunov-spryker Feb 26, 2026
ba140ae
Release notes.
vlunov-spryker Feb 26, 2026
08577e3
Release notes.
vlunov-spryker Feb 26, 2026
0690615
Fix CI issue
amansilla Feb 26, 2026
f0f6068
Release notes.
vlunov-spryker Feb 26, 2026
dc696d7
Merge branch 'release-202602' of github.com:spryker/spryker-docs into…
vlunov-spryker Feb 26, 2026
4164e2b
mention cxml support
profuel Feb 25, 2026
eb11e27
Merge pull request #3512 from spryker/release-202602
vlunov-spryker Feb 26, 2026
91ea04a
Merge pull request #3513 from spryker/reference-cxml-support
profuel Feb 26, 2026
ee4dc64
Improve product attachments business docs
amansilla Feb 26, 2026
62d1c0b
Make carousel id optional to avoid issues
amansilla Feb 26, 2026
0ff3a61
Merge pull request #3519 from spryker/improve_product_attachments
amansilla Feb 26, 2026
8766a2f
Add Docker image security notifications to release notes
Feb 26, 2026
cb8193e
Merge pull request #3520 from spryker/improve_carousel
amansilla Feb 26, 2026
f55190e
Merge branch 'master' into add-docker-images-notifications-to-release…
ArturGolda Feb 26, 2026
6eedcff
Add APM - New Relic based troubleshooting guide
ishakuta Feb 26, 2026
ea84aa9
Fix grammar, update Eco modules link, add cross-references
ishakuta Feb 26, 2026
5e71559
Fix markdownlint errors
ishakuta Feb 26, 2026
c79ff42
Fix CI
amansilla Feb 26, 2026
57381ef
add link to portal
ArturGolda Feb 26, 2026
3c88901
typo fix
ArturGolda Feb 26, 2026
978c5c1
Fix carousel displaying id
amansilla Feb 26, 2026
85cbe87
Merge pull request #3509 from spryker/add_backoffice_config_framework…
amansilla Feb 26, 2026
bc1b9d7
Merge pull request #3523 from spryker/fix_carousel
vlunov-spryker Feb 26, 2026
c2f8b3f
Merge pull request #3521 from spryker/add-docker-images-notifications…
ArturGolda Feb 26, 2026
a906fe4
Merge branch 'master' into remove-pb
vlunov-spryker Feb 26, 2026
a8c3f95
Update date.
vlunov-spryker Feb 26, 2026
06bbf7d
Add visible captions above screenshots, fix image mapping
ishakuta Feb 26, 2026
00a8f82
Merge pull request #3452 from spryker/remove-pb
vlunov-spryker Feb 26, 2026
d9921c2
Add blank lines between captions and images for proper rendering
ishakuta Feb 26, 2026
09d64cf
fix version
profuel Feb 26, 2026
6d24c91
Merge pull request #3524 from spryker/new-version
vlunov-spryker Feb 26, 2026
70669ce
Merge pull request #3522 from spryker/feature/apm-newrelic-troublesho…
feversocial Feb 26, 2026
06ded27
Wrap 2-column tables in width-100 div for full-width rendering
ishakuta Feb 26, 2026
44a03f0
Update release-notes-202602.0.md
feversocial Feb 26, 2026
a94859a
Merge pull request #3527 from spryker/feversocial-patch-1
Nidhognit Feb 26, 2026
32d06cf
Remove obsolete Backend-Gateway manual implementation from monitoring…
ishakuta Feb 26, 2026
942c710
Merge branch 'master' into fix/apm-troubleshooting-table-width
ishakuta Feb 26, 2026
59007dd
Merge pull request #3526 from spryker/fix/apm-troubleshooting-table-w…
ishakuta Feb 26, 2026
3bfc867
Streamline New Relic section in troubleshooting performance issues
ishakuta Feb 26, 2026
43c089e
Move Blackfire profiling into a dedicated child page
ishakuta Feb 26, 2026
9f56d6d
Add visuals for product attachments feature
amansilla Feb 26, 2026
8d5661a
Fix markdownlint MD007 unordered list indentation errors
ishakuta Feb 26, 2026
ef0b32d
Merge pull request #3528 from spryker/fix/troubleshooting-perf-link-t…
ishakuta Feb 26, 2026
0251c46
Merge pull request #3483 from spryker/web-profiler-propel
vitaliiivanovspryker Feb 26, 2026
7511baf
Merge branch 'master' of github.com:spryker/spryker-docs into feature…
vitaliiShveider Feb 27, 2026
2e324ca
Update upgrade-the-back-office-to-bootstrap-5.md
profuel Feb 27, 2026
7f1e68d
Update upgrade-the-back-office-to-bootstrap-5.md
profuel Feb 27, 2026
cc40e93
Test new badges
amansilla Feb 26, 2026
dfa4f61
renamed to Simplified Data Export
vitaliiShveider Feb 27, 2026
dfce1ec
renamed to Simplified Data Export
vitaliiShveider Feb 27, 2026
332c794
Update upgrade-the-back-office-to-bootstrap-5.md
profuel Feb 27, 2026
240ee93
Update upgrade-the-back-office-to-bootstrap-5.md
profuel Feb 27, 2026
eaa5453
Merge pull request #3532 from spryker/profuel-patch-1
profuel Feb 27, 2026
9c1d551
Fix CI
amansilla Feb 27, 2026
a3e63f4
update last updated
vitaliiShveider Feb 27, 2026
c8168d5
Merge branch 'master' of github.com:spryker/spryker-docs into feature…
vitaliiShveider Feb 27, 2026
74b6be6
Merge pull request #3531 from spryker/_new_badges
amansilla Feb 27, 2026
bf2f4b5
Merge pull request #3328 from spryker/feature/new-data-export
Nidhognit Feb 27, 2026
ccf9924
replace master with the released tag
profuel Feb 27, 2026
234ed8f
Merge pull request #3533 from spryker/remove-master-tag
profuel Feb 27, 2026
85ef343
add disclaimer for cypress and robot core tests
OKrivtsova Mar 2, 2026
a0a8e13
updated last updated date
OKrivtsova Mar 2, 2026
11107c9
fixed overpoliteness
OKrivtsova Mar 2, 2026
c5daa54
Update docs/dg/dev/guidelines/testing-guidelines/cypress-testing.md
OKrivtsova Mar 2, 2026
4807c8b
Update docs/dg/dev/guidelines/testing-guidelines/running-tests-with-r…
OKrivtsova Mar 2, 2026
c95f559
2
pyvovarov-s May 12, 2026
cd7e3ed
3
pyvovarov-s May 12, 2026
1735349
finished step 4 (before merge)
pyvovarov-s May 12, 2026
771a91f
Merge branch 'archive' into post_release_archive_202602
pyvovarov-s May 12, 2026
fdb47fd
deduplicate
pyvovarov-s May 14, 2026
109726f
revert files
pyvovarov-s May 14, 2026
c44c3c0
success build
pyvovarov-s May 15, 2026
0607082
Merge branch 'archive' into archive_latest_deduplicate_version_202602
pyvovarov-s May 15, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
5 changes: 5 additions & 0 deletions .claude/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Local Claude Instructions

Include:

@CLAUDE.local.md
72 changes: 72 additions & 0 deletions .claude/skills/spryker-ci/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: spryker-ci
description: Run continuous integration tools and fix issues.
---

# SprykerCI Fixing Process

Use this skill to systematically run continuous integration tools and fix errors in the Spryker documentation.

## Process

1. **Run SprykerCI**:

2. **Results for issues**:
When there is issue output:
- Identify problematic
- Why the error exists (explanation of the type issue)
- Current code snippet
- Proposed fix with explanation
- Wait for user approval before applying

3. **Verify**: Run the full SprykerCI execution path again

## Important Notes

- **Always get user approval** before applying each fix
- Present one error at a time for manageable review
- Explain WHY the error exists / test fail, not just HOW to fix it
- User may have domain knowledge that affects the fix (e.g., knowing a value is never null)
- Use type casts when user confirms value is always set
- Use null checks when uncertain

## Example Workflow

```
1. Run SprykerCI
2. Present Issue #1:
- What: [what has failed]
- Why: [explanation]
- Fix: [proposed solution]
3. User approves → Apply fix
4. Run SprykerCI for this module again to verify success
9. Present Issue #2...
10. Continue until all errors/tests presented and approved
11. Run SprykerCI again to verify success
```

## Fix guidelines

### Sidebar issues

When there is a page missing in the sidebar the issues shows fileName.md to be missing. TO fix this use the same path to be added and replace `md` with `html`.

To get the title read the file that was mentioned rto be missing and get the title from it.

## Commands

Run Vale
```bash
vale $(find docs/ _includes/pbc/ -type f -name "*.md" ! -path "*/202311.0/*" ! -path "*/202404.0/*") --minAlertLevel=error
```

Run Markdown Linter
```bash
npx markdownlint-cli2 "docs/**/*.md" "_includes/pbc/**/*.md" "#node_modules"
```

Run Sidebar checker
```bash
./_scripts/sidebar_checker/sidebar_checker.sh
```

145 changes: 145 additions & 0 deletions .github/instructions/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Spryker Documentation Repository Guidelines

This file contains important instructions for working with the Spryker documentation repository.

## Validation Workflow

### Finding Changed Files

When working on a branch, find all changed markdown files compared to master:

```bash
git diff master..HEAD --name-only | grep '.md'
```

### Running Validation Tools

Run both validation tools on changed files:

**Vale (prose linting):**
```bash
vale --minAlertLevel=error path/to/file.md
```

**Markdownlint (markdown syntax):**
```bash
markdownlint-cli2 path/to/file.md
```

**Installation:** If vale or markdownlint-cli2 are not installed, install them according to the OS requirements.

### Validation Policy

- **ONLY address ERRORS**, not warnings or suggestions
- Provide specific fixes for each error found
- Validate all changed files before completing work

## Documentation Standards

Follow documentation Standards to ensure content is high-quality and consistent with Spryker documentation standards.

### Internal Links Format

All relative internal links MUST follow this format:

```markdown
[link text](/docs/section/file.html)
```

**Rules:**
- Path starts with `/`
- Path ends with `.html` (NOT `.md`)
- Use the actual file path, replacing `.md` extension with `.html`

**Example:**
- File location: `docs/dg/dev/integrate-and-configure/integrate-development-tools/integrate-web-profiler.md`
- Link format: `[Web Profiler Integration](/docs/dg/dev/integrate-and-configure/integrate-development-tools/integrate-web-profiler.html)`

### Purpose and Goals

- Evaluate content intended for documentation on docs.spryker.com
- Ensure Markdown code for Jekyll meets high-quality standards in tone, writing style, grammar, and web best practices
- Provide specific, actionable amendments to improve the article
- **ONLY show amendments - do not show "no change" items**

### Grammar and Sentence Structure

- Identify grammatical errors:
- Typos
- Incorrect verb tense
- Subject-verb agreement issues
- Incorrect punctuation
- Evaluate sentence structure for clarity and conciseness
- Identify sentences that are too long, complex, or unclear
- Formulate improved sentence structures for better readability
- Ensure Markdown is correct and content conforms with web best practices (alt text, no skipped headings)

### Tone of Voice

Analyze the overall tone to align with technical documentation styles (Google Developer Documentation Style Guide, Microsoft Style Guide). The tone should be:
- Formal yet helpful
- Encouraging
- Clear and concise
- Consistent
- Warm, relaxed, and ready to lend a hand

**Required tone elements:**
- Use second person ('you') to address the reader directly
- Use active voice for clarity
- Use present tense where appropriate for immediacy
- Avoid contractions (use 'do not' instead of 'don't')
- Use appropriate technical terms, avoiding unnecessary jargon

### Writing Style, Markup and Markdown

**Spelling:**
- Use American spelling consistently

**Markdown Formatting:**
- Use standard Markdown for headings, lists, links, code blocks, and inline formatting
- Verify proper use of headings, lists, code blocks, links, bolding, italics, etc.
- Use Jekyll-compatible syntax for Spryker-specific components:
- `{% info_block infoBox "Info" %}...{% endinfo_block %}` instead of `> [!NOTE]`
- Apply other Spryker Liquid tags as needed:
- `{% include %}`
- `{% info_block warningBox "Warning" %}`
- Ensure output renders correctly in Jekyll but remains readable in raw Markdown

### Presenting Suggestions

Present all suggestions in a numbered list. Each item must have:

1. **Original markdown code** - The current text/code
2. **New markdown code** - The improved version
3. **Summary of the change** - Brief explanation of what was changed and why

**Example format:**
```
1. **Original:** `This is the old text.`
**New:** `This is the improved text.`
**Summary:** Changed passive voice to active voice for clarity.
```

## Workflow Automation

When asked to "build" or "validate" documentation:
1. Find all changed markdown files
2. Run vale on each file
3. Run markdownlint-cli2 on each file
4. Report only errors (not warnings)
5. Suggest specific fixes for each error
6. Check internal links format and fix if needed
7. Validate with Documentation Standards

### Best Practices

- Always validate documentation changes before committing
- Fix validation errors immediately
- Maintain consistency with surrounding content
- Ensure all internal links are valid and properly formatted
- Follow Documentation Standards for generation and validation of documentation

### Limitations

- Do not suggest removing any part of the document unless it violates a documented rule in the style guides or validation tools
- If removal seems beneficial but isn't required by the rules, note it as an optional consideration rather than a recommendation
22 changes: 22 additions & 0 deletions .github/workflows/check_last_modified.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Check last_updated is not older than 30 days

on:
pull_request:
types:
- opened
- synchronize

jobs:
check-sidebar-links:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Check last_updated is not older than 30 days for files with 1 changed line
env:
GITHUB_BASE_SHA: ${{ github.event.pull_request.base.sha }}
run: /bin/bash ./_scripts/last_updated_checker.sh 1 30
1 change: 0 additions & 1 deletion .vale-ignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
lx0amx3m1b
docs/pbc/all/payment-service-provider/202410.0/base-shop/third-party-integrations/powerpay.md:115.1.2.9/2018
SprykerEco.Computop
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Packages = Google, Spryker

[NoQuestionInHeadings]
# List of file globs to ignore for this rule
ignored = docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/vertex-faq.md
ignored =

[*.{md}]
BasedOnStyles = Google, Spryker, terms
Expand Down
Loading
Loading