Skip to content

docs: Add documentation for FlatRun UI#73

Open
Lantum-Brendan wants to merge 5 commits into
flatrun:mainfrom
Lantum-Brendan:docs/create-docs
Open

docs: Add documentation for FlatRun UI#73
Lantum-Brendan wants to merge 5 commits into
flatrun:mainfrom
Lantum-Brendan:docs/create-docs

Conversation

@Lantum-Brendan

Copy link
Copy Markdown
Collaborator

Add docs.json manifest and 4 markdown files covering overview, development setup, connecting to agent, and production deployment.

@sourceant

sourceant Bot commented Jun 25, 2026

Copy link
Copy Markdown

Code Review Summary

The PR introduces comprehensive documentation for the FlatRun UI, including a manifest for the documentation system and four core guides covering setup, connection, and deployment.

🚀 Key Improvements

  • Added a structured manifest docs.json for integration with documentation kits.
  • Provided clear Nginx and Docker deployment examples.
  • Defined a clear project structure for contributors in docs/development.md.

💡 Minor Suggestions

  • Standardize Nginx proxy headers to include X-Forwarded-For.
  • Suggest multi-stage builds for Docker to improve reproducibility.

@sourceant sourceant Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review complete. See the overview comment for a summary.

Comment thread docs/deployment.md
try_files $uri $uri/ /index.html;
}

location /api {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The Nginx configuration for /api is missing the rewrite directive if the backend agent doesn't expect the /api prefix, or it may need trailing slash consistency. Also, proxy_set_header X-Forwarded-For is a standard best practice for identifying the client IP through proxies.

Suggested change
location /api {
location /api/ {
proxy_pass http://localhost:8090/;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

Comment thread docs/deployment.md
### Docker Deployment

```dockerfile
FROM nginx:alpine

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The Dockerfile relies on a local dist/ folder and a nginx.conf that might not exist in the root. It is safer to suggest a multi-stage build to ensure the build environment is consistent and doesn't depend on the host machine's state.

Suggested change
FROM nginx:alpine
# Build stage
FROM node:18-alpine as build-stage
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
RUN npm run build
# Production stage
FROM nginx:stable-alpine
COPY --from=build-stage /app/dist /usr/share/nginx/html
EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]

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.

1 participant