docs: use npm in makefile and cursor rules (#11784)
* update-makefile-to-use-npm * update-cursor-rules-file-to-use-npm
This commit is contained in:
@@ -22,14 +22,14 @@ Guidelines for developing and maintaining Langflow documentation using Docusauru
|
||||
|
||||
### Prerequisites
|
||||
- **Node.js:** v22.12 LTS for runtime
|
||||
- **Package Manager:** Yarn for dependency management
|
||||
- **Package Manager:** npm for dependency management
|
||||
- **Documentation Framework:** Docusaurus v3
|
||||
|
||||
### Documentation Service
|
||||
```bash
|
||||
cd docs
|
||||
yarn install # Install dependencies
|
||||
yarn start # Start dev server (usually port 3001)
|
||||
npm install # Install dependencies
|
||||
npm run start # Start dev server (usually port 3001)
|
||||
```
|
||||
- Auto-reloads on documentation changes
|
||||
- Access at: http://localhost:3001/
|
||||
@@ -373,8 +373,8 @@ module.exports = {
|
||||
### Link Checking
|
||||
```bash
|
||||
# Check for broken internal links
|
||||
yarn build
|
||||
yarn serve
|
||||
npm run build
|
||||
npm run serve
|
||||
# Manual testing or use link checker tools
|
||||
```
|
||||
|
||||
@@ -419,8 +419,8 @@ yarn serve
|
||||
|
||||
### Local Testing
|
||||
```bash
|
||||
yarn build # Build static site
|
||||
yarn serve # Serve built site locally
|
||||
npm run build # Build static site
|
||||
npm run serve # Serve built site locally
|
||||
```
|
||||
|
||||
### Production Deployment
|
||||
@@ -431,7 +431,7 @@ yarn serve # Serve built site locally
|
||||
---
|
||||
|
||||
## Documentation Development Checklist
|
||||
- [ ] Documentation service running with `yarn start`
|
||||
- [ ] Documentation service running with `npm run start`
|
||||
- [ ] Content follows markdown conventions
|
||||
- [ ] Code examples are tested and working
|
||||
- [ ] Images have descriptive alt text
|
||||
@@ -440,4 +440,4 @@ yarn serve # Serve built site locally
|
||||
- [ ] Content follows style guide
|
||||
- [ ] Screenshots are current and properly formatted
|
||||
- [ ] Cross-references between related topics
|
||||
- [ ] Build succeeds with `yarn build`
|
||||
- [ ] Build succeeds with `npm run build`
|
||||
|
||||
20
Makefile
20
Makefile
@@ -1010,32 +1010,22 @@ help_advanced: ## show advanced and miscellaneous commands
|
||||
|
||||
docs_port ?= 3030
|
||||
|
||||
check_yarn:
|
||||
@command -v yarn >/dev/null 2>&1 || { \
|
||||
echo "$(RED)Error: yarn is not installed.$(NC)"; \
|
||||
echo "$(YELLOW)The docs project requires yarn. Please install it:$(NC)"; \
|
||||
echo " brew install yarn"; \
|
||||
echo " # or"; \
|
||||
echo " npm install -g yarn"; \
|
||||
exit 1; \
|
||||
}
|
||||
|
||||
docs_install: check_yarn ## install documentation dependencies
|
||||
docs_install: ## install documentation dependencies
|
||||
@echo "$(GREEN)Installing documentation dependencies...$(NC)"
|
||||
@cd docs && yarn install
|
||||
@cd docs && npm install
|
||||
|
||||
docs: docs_install ## start documentation development server (default port 3030)
|
||||
@echo "$(GREEN)Starting documentation server at http://localhost:$(docs_port)$(NC)"
|
||||
@cd docs && yarn start --port $(docs_port)
|
||||
@cd docs && npm run start -- --port $(docs_port)
|
||||
|
||||
docs_build: docs_install ## build documentation for production
|
||||
@echo "$(GREEN)Building documentation...$(NC)"
|
||||
@cd docs && yarn build
|
||||
@cd docs && npm run build
|
||||
@echo "$(GREEN)Documentation built successfully in docs/build/$(NC)"
|
||||
|
||||
docs_serve: docs_build ## build and serve documentation locally
|
||||
@echo "$(GREEN)Serving built documentation...$(NC)"
|
||||
@cd docs && yarn serve --port $(docs_port)
|
||||
@cd docs && npm run serve -- --port $(docs_port)
|
||||
|
||||
######################
|
||||
# INCLUDE FRONTEND MAKEFILE
|
||||
|
||||
Reference in New Issue
Block a user