Skip to content

Commit 5e6542e

Browse files
committed
Remove site structure from README
This is out of date. Best to use the source instead Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
1 parent 9064928 commit 5e6542e

1 file changed

Lines changed: 0 additions & 88 deletions

File tree

README.md

Lines changed: 0 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -31,91 +31,3 @@ The staging version of the website is published at: https://aboutcode-org.github
3131

3232
The production version of the website (Dreamhost) is published at: https://www.aboutcode.org/.
3333

34-
## Simplified website structure
35-
This section documents the website structure which necessarily follows a Docusaurus template and configuration. There are two primary ways to update the website:
36-
- Many elements of the website -- including the navbar, the footer, the sidebars, the landing page, and the blog's authors.yml and tags.yml files -- are complex to update.
37-
- For these website elements you should create an issue and the core team will create the PR or help you create one.
38-
- Most of the primary website content (including the blog posts) is composed of markdown files which are much easier to update. For these pages you will see an "Edit this
39-
page" link at the bottom of the text. You can use this link to go directly to the corresponding markdown file.
40-
- You can use the GitHub UI to create a new branch and PR or you can create a branch and PR locally in your preferred GitHub tools.
41-
42-
43-
![www.aboutcode.org navbar](./website/static/img/www-aboutcode-org-navbar-2026-02-05.png)
44-
45-
Looking at the links in the website's navbar (defined in `../website/docusaurus.config.js`) ^:
46-
47-
- **AboutCode logo**
48-
- **link**: website Home (landing page)
49-
50-
- **Home**
51-
- **link**: website landing page
52-
- **edit**: submit an issue
53-
- **structure**: website landing page is defined with a series of nested index.js, .css and other files, e.g.:
54-
- *primary index.js*: `../website/src/pages/index.js`
55-
- *HomepageHeader*: `../website/src/components/HomepageHeader/index.js`
56-
- *HomepageContent*: `../website/src/components/HomepageContent/index.js`
57-
- *HomeIntro*: `../website/src/components/HomepageContent/HomeIntro.mdx`
58-
- *ProjectOverview*: `../website/src/components/HomepageContent/ProjectOverview.md`
59-
- *ProjectGridTemplate*: `../website/src/components/ProjectGridTemplate/index.js`
60-
- *Application projects*: `../website/src/data/projects-application.json`
61-
- *ScanCode projects*: `../website/src/data/projects-scancode.json`
62-
- *Package-URL projects*: `../website/src/data/projects-package-url.json`
63-
- *Inspectors*: `../website/src/data/projects-inspectors.json`
64-
- *Libraries*: `../website/src/data/projects-libraries.json`
65-
- *Supporters*: `../website/src/components/HomepageContent/Supporters.md`
66-
67-
- **Getting Started**
68-
- **link**: a group of .md pages organized around a sidebar nav
69-
- **edit**: each .md has an `Edit this page` link in the lower-left corner of the page
70-
- **structure**:
71-
- *Getting started*: `../website/docs/getting_started/getting_started-getting-started.md`
72-
- *Software identification*: `../website/docs/getting_started/getting_started-software-identification.md`
73-
- *Security*: `../website/docs/getting_started/getting_started-security.md`
74-
- *Compliance*: `../website/docs/getting_started/getting_started-compliance.md`
75-
- *CRAVEX*: `../website/docs/getting_started/getting_started-cravex.md`
76-
77-
- **About**
78-
- **link**: a group of .md pages organized around a sidebar nav
79-
- **edit**: each .md has an `Edit this page` link in the lower-left corner of the page
80-
- **structure**:
81-
- *Contribute*: `../website/docs/about/about-contribute.md`
82-
- *Events*: `../website/docs/about/about-events.md`
83-
- *Meetings*: `../website/docs/about/about-meetings.md`
84-
- *News*: `../website/docs/about/about-news.md`
85-
- *Releases*: `../website/docs/about/about-releases.md`
86-
87-
- **Blog**
88-
- **link**: a group of .md pages organized around an auto-generated blog sidebar nav
89-
- **edit**: each post now has an `Edit this page` link in the lower-left corner of the page
90-
- **structure** (excerpt):
91-
```
92-
../website/blog
93-
├── atom-chen-aboutcode
94-
│   ├── 2025-02-04-atom-chen-aboutcode.md
95-
│   └── atom_grey-1024x683.png
96-
├── copyleft-licensed-software-java-app
97-
│   ├── 2021-01-31-copyleft-licensed-software-java-app.md
98-
│   └── java_copyleft_license.png
99-
├── curated-licenses-public-database-scancode-licensedb
100-
│   ├── 2026-01-29-scancode-licensedb.md
101-
│   ├── ScanCode-LicenseDB-1536x1085.png
102-
│   ├── ScanCode-LicenseDB-2026-01.png
103-
│   └── scancode-db-blog.png
104-
├── non-vulnerable-dependency-resolution
105-
. . .
106-
├── authors.yml
107-
├── tags.yml
108-
```
109-
110-
- **GitHub**
111-
- **link**: https://github.com/aboutcode-org/www.aboutcode.org
112-
- **edit**: submit an issue
113-
- **structure**: a link in `../website/docusaurus.config.js`
114-
115-
- **Slack**
116-
- **link**: https://aboutcode-org.slack.com/join/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og#/shared-invite/email
117-
- **edit**: submit an issue
118-
- **structure**: a link in `../website/docusaurus.config.js`
119-
120-
- **light/dark toggle**
121-
- provided by default in `classic` theme

0 commit comments

Comments
 (0)