opendal_core/docs/
mod.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! OpenDAL contracts, Rust core guides, and historical project documents.
19//!
20//! Start with [`concepts`] for the Rust core API model. [`specs`] defines the
21//! current portable contracts implemented by OpenDAL. Service and layer authors
22//! can continue with [`internals`], while [`performance`] covers application
23//! tuning. Accepted RFCs in [`rfcs`] preserve the decisions and context that
24//! led to current designs.
25
26#![allow(rustdoc::bare_urls)]
27
28pub mod concepts;
29pub mod internals;
30pub mod performance;
31pub mod specs;
32
33/// Changes log for all OpenDAL released versions.
34#[doc = include_str!("../../CHANGELOG.md")]
35#[cfg(not(doctest))]
36#[allow(rustdoc::broken_intra_doc_links, rustdoc::invalid_rust_codeblocks)]
37pub mod changelog {}
38
39#[cfg(not(doctest))]
40#[allow(rustdoc::broken_intra_doc_links, rustdoc::invalid_rust_codeblocks)]
41pub mod rfcs;
42
43/// Upgrade and migrate procedures while OpenDAL meets breaking changes.
44#[doc = include_str!("upgrade.md")]
45#[cfg(not(doctest))]
46#[allow(rustdoc::broken_intra_doc_links, rustdoc::invalid_rust_codeblocks)]
47pub mod upgrade {}
opendal_core/docs/mod.rs

opendal_core/docs/
mod.rs
