Skip to content

Commit e9a7781

Browse files
committed
docs(README): replace Starlight template content with project-specific info
- Remove generic Astro/Starlight boilerplate text - Add project logo and badges - Explain repository purpose and structure - Update contribution instructions - Add licensing information
1 parent 6d6df79 commit e9a7781

File tree

1 file changed

+43
-39
lines changed

1 file changed

+43
-39
lines changed

README.md

Lines changed: 43 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,58 @@
1-
# Starlight Starter Kit: Basics
1+
# Flutter News App - Documentation
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
This repository contains the source code for the official documentation website for the **[Flutter News App - Full Source Code Toolkit](https://github.com/flutter-news-app-full-source-code)**.
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
5+
<p>
6+
<a href="https://flutter-news-app-full-source-code.github.io/docs/"><img src="https://img.shields.io/badge/LIVE_DOCS-VIEW-green?style=for-the-badge" alt="Live Docs: View"></a>
7+
<a href="https://github.com/flutter-news-app-full-source-code"><img src="https://img.shields.io/badge/MAIN_PROJECT-BROWSE-purple?style=for-the-badge" alt="Main Project: Browse"></a>
8+
</p>
89

9-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11-
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
10+
---
1311

14-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
12+
## About This Repository
1513

16-
## 🚀 Project Structure
14+
This site is built using **[Astro](https://astro.build/)**, a modern static site generator. Its purpose is to provide comprehensive guides, tutorials, and API references for our product.
1715

18-
Inside of your Astro + Starlight project, you'll see the following folders and files:
16+
This repository is for the documentation content and its website structure only. The source code for the actual software is located in the main organization.
1917

20-
```
21-
.
22-
├── public/
23-
├── src/
24-
│ ├── assets/
25-
│ ├── content/
26-
│ │ └── docs/
27-
│ └── content.config.ts
28-
├── astro.config.mjs
29-
├── package.json
30-
└── tsconfig.json
31-
```
18+
## Running the Documentation Site Locally
3219

33-
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
20+
To preview changes or contribute to the documentation, you can run a local development server.
3421

35-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
22+
1. **Prerequisites:**
23+
* Ensure [Node.js](https://nodejs.org/) (LTS version) is installed on your system.
3624

37-
Static assets, like favicons, can be placed in the `public/` directory.
25+
2. **Clone the repository:**
26+
```bash
27+
git clone https://github.com/flutter-news-app-full-source-code/docs.git
28+
cd docs
29+
```
3830

39-
## 🧞 Commands
31+
3. **Install dependencies:**
32+
```bash
33+
npm install
34+
```
4035

41-
All commands are run from the root of the project, from a terminal:
36+
4. **Start the development server:**
37+
```bash
38+
npm run dev
39+
```
40+
The site will now be available at `http://localhost:4321`. It will automatically reload as you make changes to the content.
4241

43-
| Command | Action |
44-
| :------------------------ | :----------------------------------------------- |
45-
| `npm install` | Installs dependencies |
46-
| `npm run dev` | Starts local dev server at `localhost:4321` |
47-
| `npm run build` | Build your production site to `./dist/` |
48-
| `npm run preview` | Preview your build locally, before deploying |
49-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50-
| `npm run astro -- --help` | Get help using the Astro CLI |
42+
## 📝 License
5143

52-
## 👀 Want to learn more?
44+
## 📝 License
5345

54-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
46+
This repository uses a dual-licensing model to provide clarity for different types of content.
47+
48+
#### Documentation Content
49+
50+
All prose, tutorials, and narrative content within this documentation are licensed under the **[Creative Commons Attribution 4.0 International License (CC BY 4.0)](./LICENSE)**. This allows our guides to be openly shared and improved by the community.
51+
52+
#### Code Snippets
53+
54+
All code examples and snippets embedded within the documentation are a separate matter. Unless otherwise specified, they are dedicated to the **[Public Domain via CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/)**.
55+
56+
This means you are free to copy, paste, modify, and use these illustrative snippets in your own applications without restriction.
57+
58+
This dual-licensing approach ensures our documentation is open and shareable, while protecting the commercial value of the underlying source code product, which is governed by our **[Lifetime Developer License](https://github.com/flutter-news-app-full-source-code/.github/blob/main/LIFETIME_DEVELOPER_LICENSE.md)**.

0 commit comments

Comments
 (0)