Skip to content

Commit 1fb41e4

Browse files
committed
Fix docs: hide loginWithProvider, show realtime types, remove README.mdx
1 parent 4ebed0d commit 1fb41e4

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

scripts/mintlify-post-processing/copy-to-local-docs.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,12 @@ function main() {
248248
console.log(`Copying docs to ${sdkDocsTarget}...`);
249249
fs.cpSync(DOCS_SOURCE_PATH, sdkDocsTarget, { recursive: true });
250250

251+
// Remove README.mdx - it's not used in the docs navigation
252+
const readmePath = path.join(sdkDocsTarget, "README.mdx");
253+
if (fs.existsSync(readmePath)) {
254+
fs.rmSync(readmePath, { force: true });
255+
}
256+
251257
// Scan the sdk-docs directory
252258
const sdkFiles = scanSdkDocs(sdkDocsTarget);
253259
console.debug(`SDK files: ${JSON.stringify(sdkFiles, null, 2)}`);

src/modules/auth.types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ export interface AuthModule {
204204
* // Login with GitHub and redirect to dashboard
205205
* base44.auth.loginWithProvider('microsoft', '/dashboard');
206206
* ```
207+
* @internal
207208
*/
208209
loginWithProvider(provider: string, fromUrl?: string): void;
209210

src/modules/entities.types.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
/**
22
* Event types for realtime entity updates.
3-
* @internal
43
*/
54
export type RealtimeEventType = "create" | "update" | "delete";
65

76
/**
87
* Payload received when a realtime event occurs.
9-
* @internal
108
*/
119
export interface RealtimeEvent {
1210
/** The type of change that occurred */
@@ -21,13 +19,11 @@ export interface RealtimeEvent {
2119

2220
/**
2321
* Callback function invoked when a realtime event occurs.
24-
* @internal
2522
*/
2623
export type RealtimeCallback = (event: RealtimeEvent) => void;
2724

2825
/**
2926
* Function returned from subscribe, call it to unsubscribe.
30-
* @internal
3127
*/
3228
export type Subscription = () => void;
3329

0 commit comments

Comments
 (0)