Skip to content

Add "How to Run WinterCMS Documentation Locally" - #6

Open
Satoshi-Sh wants to merge 1 commit into
wintercms:mainfrom
Satoshi-Sh:doc/local-devlopment-guide
Open

Satoshi-Sh wants to merge 1 commit into
wintercms:mainfrom
Satoshi-Sh:doc/local-devlopment-guide

Conversation

@Satoshi-Sh

Copy link
Copy Markdown
Contributor

Updates

Added a guide on how to run WinterCMS Documentaion site for contributors.

This PR needs to add the instruction on how to add required theme(doc) and plugin(winterdoc)

Some errors

While testing, I encountered the following errors. The documentaion is working fine.
Screenshot from 2025-06-06 18-36-22
I don't know those errors are important or not.

@bennothommo

Copy link
Copy Markdown
Member

@Satoshi-Sh, I think this could be better integrated into the Development section that's already part of the README instead of just being a list dump of commands.

As for the errors - that'd be coming from the Search plugin. When did those errors appear - which command were you running at the time?

@Satoshi-Sh
Satoshi-Sh force-pushed the doc/local-devlopment-guide branch from fb73cf2 to 857e06f Compare June 10, 2025 13:46
@Satoshi-Sh

Copy link
Copy Markdown
Contributor Author

@bennothommo Thanks for the feedback, I moved the instruction into the Development section.

I got those errors when I ran php artisan doc:process. Probably, I need to configure the search plugin?

@LukeTowers

Copy link
Copy Markdown
Member

@bennothommo I know I've run into those issues myself before, is there something missing from the search plugin or am I just not setting it up correctly?

@bennothommo

Copy link
Copy Markdown
Member

@Satoshi-Sh @LukeTowers those DBs are created (using the ArraySource trait) when you generate indexes for the docs, but that's done as part of the docs:process action, so I can only assume it's some sort of race condition where the indexes are being queried before they're being generated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants