Skip to content

Commit

Permalink
docs: update documentation for a more inclusive environment and added…
Browse files Browse the repository at this point in the history
… japanese and chinese documentation
  • Loading branch information
kangfenmao committed Oct 24, 2024
1 parent 64ad2fc commit cfb3eb7
Show file tree
Hide file tree
Showing 12 changed files with 34 additions and 197 deletions.
41 changes: 19 additions & 22 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,29 @@
This software is licensed under the **Apache License 2.0**. In addition to the terms of the Apache License 2.0, the following additional terms apply to the use of Cherry Studio:
# Code of Conduct

**I. Commercial Use License**
## Our Pledge

1. **Free Commercial Use**: Users can use the software for commercial purposes without modifying the code.
2. **Commercial License Required**: A commercial license is required if any of the following conditions are met:
1. You modify, develop, or alter the software, including but not limited to changes to the application name, logo, code, or functionality.
2. You provide multi-tenant services to enterprise customers with 10 or more users.
3. You pre-install or integrate the software into hardware devices or products and bundle it for sale.
4. You are engaging in large-scale procurement for government or educational institutions, especially involving security, data privacy, or other sensitive requirements.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

**II. Contributor Agreement**
## Our Standards

As a contributor to Cherry Studio, you agree to the following:
Examples of behavior that contributes to creating a positive environment include:

1. **License Adjustment**: The producer reserves the right to adjust the open-source license as needed, making it stricter or more lenient.
2. **Commercial Use**: Any code you contribute may be used for commercial purposes, including but not limited to cloud business operations.
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

**III. Other Terms**
Examples of unacceptable behavior by participants include:

1. The interpretation of these terms is subject to the discretion of Cherry Studio developers.
2. These terms may be updated, and users will be notified through the software when changes occur.
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

For any questions or to request a commercial license, please contact the Cherry Studio development team.
## Our Responsibilities

Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at http://www.apache.org/licenses/LICENSE-2.0.
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

---

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</a>
</div>
<div align="center">
English | <a href="./README.zh.md">中文</a> | <a href="./README.ja.md">日本語</a>
English | <a href="./docs/README.zh.md">中文</a> | <a href="./docs/README.ja.md">日本語</a>
</div>

# 🍒 Cherry Studio
Expand Down
File renamed without changes.
File renamed without changes.
95 changes: 0 additions & 95 deletions docs/dev/faq.md

This file was deleted.

72 changes: 0 additions & 72 deletions docs/dev/structure.md

This file was deleted.

2 changes: 1 addition & 1 deletion electron-builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ electronDownload:
afterSign: scripts/notarize.js
releaseInfo:
releaseNotes: |
修复滚动条显示问题
增加数学公式渲染引擎切换
多个系统滚动条样式统一
修复添加默认助手会添加两个
1 change: 1 addition & 0 deletions src/renderer/src/assets/styles/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ html,
body,
#root {
height: 100%;
width: 100%;
margin: 0;
}

Expand Down
1 change: 1 addition & 0 deletions src/renderer/src/pages/home/HomePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ const Container = styled.div`
display: flex;
flex: 1;
flex-direction: column;
max-width: calc(100vw - var(--sidebar-width));
`

const ContentContainer = styled.div`
Expand Down
10 changes: 7 additions & 3 deletions src/renderer/src/pages/home/Messages/Messages.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const Messages: FC<Props> = ({ assistant, topic, setActiveTopic }) => {
const showRightTopics = showTopics && topicPosition === 'right'
const minusAssistantsWidth = showAssistants ? '- var(--assistants-width)' : ''
const minusRightTopicsWidth = showRightTopics ? '- var(--assistants-width)' : ''
return `calc(100vw - var(--sidebar-width) ${minusAssistantsWidth} ${minusRightTopicsWidth}`
return `calc(100vw - var(--sidebar-width) ${minusAssistantsWidth} ${minusRightTopicsWidth} - 5px)`
}, [showAssistants, showTopics, topicPosition])

const onSendMessage = useCallback(
Expand Down Expand Up @@ -220,7 +220,12 @@ const Messages: FC<Props> = ({ assistant, topic, setActiveTopic }) => {
}, [assistant, messages])

return (
<Container id="messages" style={{ maxWidth }} key={assistant.id} ref={containerRef} right>
<Container
id="messages"
style={{ maxWidth }}
key={assistant.id}
ref={containerRef}
right={topicPosition === 'left'}>
<Suggestions assistant={assistant} messages={messages} lastMessage={lastMessage} />
{lastMessage && <MessageItem key={lastMessage.id} message={lastMessage} lastMessage />}
{reverse([...messages]).map((message, index) => (
Expand All @@ -245,7 +250,6 @@ const Container = styled(Scrollbar)`
background-color: var(--color-background);
padding-bottom: 20px;
overflow-x: hidden;
margin-right: 3px;
`

export default Messages
4 changes: 2 additions & 2 deletions src/renderer/src/pages/home/Tabs/Topics.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const Topics: FC<Props> = ({ assistant: _assistant, activeTopic, setActiveTopic
const { assistant, removeTopic, moveTopic, updateTopic, updateTopics } = useAssistant(_assistant.id)
const { t } = useTranslation()
const generating = useAppSelector((state) => state.runtime.generating)
const { showTopicTime } = useSettings()
const { showTopicTime, topicPosition } = useSettings()

const borderRadius = showTopicTime ? 12 : 17

Expand Down Expand Up @@ -178,7 +178,7 @@ const Topics: FC<Props> = ({ assistant: _assistant, activeTopic, setActiveTopic
)

return (
<Container>
<Container right={topicPosition === 'right'}>
<DragableList list={assistant.topics} onUpdate={updateTopics}>
{(topic) => {
const isActive = topic.id === activeTopic?.id
Expand Down
3 changes: 2 additions & 1 deletion src/renderer/src/pages/home/Tabs/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,8 @@ const HomeTabs: FC<Props> = ({ activeAssistant, activeTopic, setActiveAssistant,
const Container = styled.div`
display: flex;
flex-direction: column;
width: var(--assistants-width);
max-width: var(--assistants-width);
min-width: var(--assistants-width);
height: calc(100vh - var(--navbar-height));
overflow: hidden;
.collapsed {
Expand Down

0 comments on commit cfb3eb7

Please sign in to comment.