Docs: no explanation of generated files and what the .txt files are for
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 142k
- Forks
- 32.4k
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 351
Description
What is the improvement or update you wish to see?
I generally like to understand what a framework does and how it works up front, before diving in.
I'm using a next.js static site template, so I don't really want to build a full nextjs app. I'm just trying to understand what's going on at a surface level.
Generating the static site server side (output: export) yields the expected pile of js/html/etc files, but also for every page a txt file that appears to contain a set of serialized json objects containing HTML. I've searched in vain to try and understand what these are for, but am left guessing.
It would be good to document what the output artifacts of a nextjs static site are.
Is there any context that might help us understand?
N/A
Does the docs page already exist? Please link to it.
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the static site template and the output produced by output: export, focusing on the generated .txt files and their serialized JSON/HTML contents. Done means the Next.js documentation explains the purpose of the static export artifacts, including the per-page .txt files, at a surface level.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nextjs
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100