Skip to content

Commit d5b21bc

Browse files
fix links
1 parent 2046bb1 commit d5b21bc

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

website/docs/reference/faq.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ OpenComponents is a framework for building micro frontends - small, independent
1313
### When should I use OpenComponents?
1414

1515
OpenComponents is ideal when you have:
16+
1617
- Multiple teams working on different parts of the UI
1718
- Need to share components across different applications
1819
- Want to deploy parts of your frontend independently
@@ -21,6 +22,7 @@ OpenComponents is ideal when you have:
2122
### How is this different from regular React/Vue components?
2223

2324
Unlike framework-specific components, OpenComponents:
25+
2426
- Work across different frameworks (React, Vue, Angular, etc.)
2527
- Can be deployed and updated independently
2628
- Have their own server-side logic and data fetching
@@ -36,15 +38,15 @@ For **creating** components: Basic Node.js knowledge is helpful, but our [Quick
3638
### What's the difference between rendered and un-rendered components?
3739

3840
Un-rendered components delegate the rendering to the clients. This is useful for performance and cacheability.
39-
[More details about rendered components](architecture-overview#consuming-rendered-components) and about [un-rendered components](architecture-overview#consuming-un-rendered-components)
41+
[More details about rendered components](../concepts/architecture-overview#consuming-rendered-components) and about [un-rendered components](../concepts/architecture-overview#consuming-un-rendered-components)
4042

4143
## What happens when a publish is made?
4244

43-
[Look at this page](architecture-overview#what-happens-when-a-publish-is-made)
45+
[Look at this page](../concepts/architecture-overview#what-happens-when-a-publish-is-made)
4446

4547
## How the distribution works?
4648

47-
[Look at this page](architecture-overview#how-distribution-works)
49+
[Look at this page](../concepts/architecture-overview#how-distribution-works)
4850

4951
## Can I link a CDN on top of the S3 bucket?
5052

@@ -73,13 +75,14 @@ For example, at OpenTable we do logging with the ELK stack for business metrics,
7375

7476
## Can I setup a debugger with Visual Studio Code?
7577

76-
Yes, [look at this page](debugging).
78+
Yes, [look at this page](../building/debugging).
7779

7880
## Performance Questions
7981

8082
### How does OpenComponents affect page load performance?
8183

8284
OpenComponents can improve performance through:
85+
8386
- **Caching**: Components are cached at multiple levels
8487
- **CDN delivery**: Static assets served from CDN
8588
- **Lazy loading**: Components can be loaded on-demand
@@ -104,12 +107,14 @@ Yes! OpenComponents works excellently with CDNs. Set the `s3.path` property in y
104107
### My component shows "Loading..." forever
105108

106109
**Common causes:**
110+
107111
1. **Registry not accessible** - Check if the registry URL is reachable
108112
2. **JavaScript errors** - Check browser console for errors
109113
3. **Template compilation errors** - Verify your template syntax
110114
4. **Network issues** - Check network connectivity
111115

112116
**Solutions:**
117+
113118
```bash
114119
# Test registry accessibility
115120
curl https://your-registry.com/your-component
@@ -122,6 +127,7 @@ oc preview http://localhost:3030/your-component
122127
### Publishing fails with authentication errors
123128

124129
**Solutions:**
130+
125131
1. Verify your username and password
126132
2. Check if the registry URL is correct
127133
3. Ensure you have publishing permissions
@@ -130,6 +136,7 @@ oc preview http://localhost:3030/your-component
130136
### Component works locally but fails in production
131137

132138
**Common issues:**
139+
133140
1. **Environment variables** - Ensure all required env vars are set
134141
2. **Dependencies** - Check if all dependencies are installed
135142
3. **CORS issues** - Verify cross-origin settings
@@ -138,16 +145,19 @@ oc preview http://localhost:3030/your-component
138145
### Template compilation errors
139146

140147
**For ES6 templates (default):**
148+
141149
- Check for proper template literal syntax: `${variable}` not `{variable}`
142150
- Ensure template function returns valid HTML string
143151
- Verify all variables are defined in server.js
144152

145153
**For React templates:**
154+
146155
- Verify JSX syntax
147156
- Check for missing imports
148157
- Ensure proper export statements
149158

150159
**For legacy Handlebars templates:**
160+
151161
- Check for unescaped special characters
152162
- Verify all variables are defined in server.js
153163
- Ensure proper syntax: `{{variable}}` not `{variable}`
@@ -157,12 +167,14 @@ oc preview http://localhost:3030/your-component
157167
### How do I test components before publishing?
158168

159169
1. **Local development:**
170+
160171
```bash
161172
oc dev . 3030
162173
oc preview http://localhost:3030/your-component
163174
```
164175

165176
2. **Dry run publishing:**
177+
166178
```bash
167179
oc publish your-component --dryRun
168180
```
@@ -173,6 +185,7 @@ oc preview http://localhost:3030/your-component
173185
### Can I use TypeScript with OpenComponents?
174186

175187
Yes! Many templates support TypeScript:
188+
176189
- Use React templates with TypeScript
177190
- Configure your build process accordingly
178191
- Ensure proper type definitions
@@ -202,6 +215,7 @@ Yes! Many templates support TypeScript:
202215
### Is OpenComponents production-ready?
203216

204217
Yes! OpenComponents is used in production by many companies. However:
218+
205219
- Ensure proper monitoring and alerting
206220
- Have fallback strategies for component failures
207221
- Test thoroughly in your specific environment

website/src/components/HomepageFeatures.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const FeatureList: FeatureItem[] = [
4040
supporting multiple frameworks, so teams can choose the best tool for
4141
their needs without being locked into a single technology stack.
4242
</p>
43-
<Link to="/docs/miscellaneous/template-system">Learn more</Link>
43+
<Link to="/docs/building/template-system">Learn more</Link>
4444
</>
4545
),
4646
},

0 commit comments

Comments
 (0)