nebari-dev / nebari-dev/llm-serving-pack
[DOC] - Create placeholder documentation
Open
Nobody has claimed this yet.
area: documentation 📖
priority: medium ⚡
type: maintenance 🛠
- Dominant language
- Go
- Stars
- 3
- Forks
- 3
- Avg merge
- 16h 31m
- Merged PRs (30d)
- 11
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
Add placeholder docs and framework for building and deploying:
- github workflow that builds in pr and deploys to gh pages on merge to main
- docusaurus/typescript/npm configs
- readme.md on tools, how to build, serve ect
- docs/introduction page
- relevant styling assets
- update .gitignore
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
Review the repository root and verify the listed Docusaurus, TypeScript, npm, GitHub workflow, README, docs/introduction, styling assets, and .gitignore work. Start by checking which checklist items are actually present and how the documentation build is run. Done means the placeholder documentation framework and its pull-request build and main-branch deployment are complete and reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, markdown, typescript
- Domain
- build-system, ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100