Bouba b-barry

Update Documentation

You will generate LLM-optimized documentation with concrete file references and flexible formatting.

Your Task

Create documentation that allows humans and LLMs to:

Understand project purpose - what the project does and why
Get architecture overview - how the system is organized
Build on all platforms - build instructions with file references

I have been utilizing artificial intelligence to enhance and optimize my codebases. After evaluating various models, applications, and editors, I find the claude.ai interface with a Pro Account to be the most effective. Here’s the approach I’ve developed to achieve optimal results:

This gist contains a carefully crafted prompt and a script designed to convert your entire Laravel codebase (excluding the resources folder, which can be easily added if needed) into a TXT file with the following structure:

<File Start: ./path/filename.extension> Content of file <End File: ./path/filename.extension>

To implement this method:

Access Control (Creating a Secure and Trusted Application)

Access control is critical to the security of our application. Beyond proper credential encryption, hashing, SALTing etc, access control is the next line of defense in protecting our users data.

Role Based Access Control Methodology (RBAC)

When giving elevated access to a User for a particular part of the system, we use a methodology called RBAC. This means that we create Roles where we assign permissions and apply filter policies. These Roles then get assigned to Users who have their CRUD access to Lists, Records, and Fields determined accordingly.

Our Access Control Philosophy

Pure ESM package

The package that linked you here is now pure ESM. It cannot be require()'d from CommonJS.

This means you have the following choices:

Use ESM yourself. (preferred)
Use import foo from 'foo' instead of const foo = require('foo') to import the package. You also need to put "type": "module" in your package.json and more. Follow the below guide.
If the package is used in an async context, you could use await import(…) from CommonJS instead of require(…).
Stay on the existing version of the package until you can move to ESM.

	// Types for the result object with discriminated union
	type Success<T> = {
	data: T;
	error: null;
	};

	type Failure<E> = {
	data: null;
	error: E;
	};

	import * as React from 'react';

	const useIsFirstRender = (): boolean => {
	const isFirst = React.useRef(true);

	if (isFirst.current) {
	isFirst.current = false;

	return true;
	} else {

	import axios from 'axios'
	import { useOptimisticMutation } from "./useOptimisticMutation.ts"

	type Response = boolean
	type Error = unknown
	type MutationVariables = {itemId: string}
	type Items = {id: string; name: string}[]
	type Likes = {itemId: string}[]
	type History = {type: string}[]

	import React from 'react'
	import { Button } from '@/modules/design-system/primitives/Button'
	import { deleteResourceById } from '@/modules/crud/queries/resource'
	import { ValidationPanel } from '@/modules/design-system/components/SidePanel/SidePanel'

	export interface ResourceDeletionProps {
	resource: any
	refetch: () => void
	}

	/** A parsed JSON value. */
	export type json =
	\| string
	\| number
	\| boolean
	\| null
	\| json[]
	\| { [key: string]: json };

	/** A JSON stringify-able value. */

	import { createHash } from "crypto";
	import fs from "fs";
	import fsp from "fs/promises";
	import path from "path";
	import https from "https";
	import { PassThrough } from "stream";
	import type { Readable } from "stream";
	import type { LoaderFunction } from "remix";
	import sharp from "sharp";
	import type { Request as NodeRequest } from "@remix-run/node";